[TASK] CGL cleanup for the new module menu classes
authorSusanne Moog <typo3@susannemoog.de>
Sun, 24 Jun 2012 14:02:08 +0000 (16:02 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sun, 24 Jun 2012 14:04:24 +0000 (16:04 +0200)
The new module menu classes have some CGL issues left.

Patch fixes missing comments and some wrong object
annotations.

Change-Id: I7b8e810fe732977e9efbd56075683601658971f4
Resolves: #38347
Releases: 6.0
Reviewed-on: http://review.typo3.org/12329
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/classes/Domain/Model/BackendModule.php
typo3/classes/ModuleStorage.php
typo3/classes/Utility/BackendModuleUtility.php

index d867b45..b735a36 100644 (file)
@@ -82,13 +82,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set children
+        *
         * @param \SplObjectStorage $children
+        * @return void
         */
        public function setChildren($children) {
                $this->children = $children;
        }
 
        /**
+        * Get children
+        *
         * @return \SplObjectStorage
         */
        public function getChildren() {
@@ -96,20 +101,28 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
-        * @param Typo3_BackendModule $child
+        * Add Child
+        *
+        * @param Typo3_Domain_Model_BackendModule $child
+        * @return void
         */
        public function addChild(Typo3_Domain_Model_BackendModule $child) {
                $this->children->attach($child);
        }
 
        /**
+        * Set icon
+        *
         * @param array $icon
+        * @return void
         */
        public function setIcon(array $icon) {
                $this->icon = $icon;
        }
 
        /**
+        * Get icon
+        *
         * @return array
         */
        public function getIcon() {
@@ -117,13 +130,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set name
+        *
         * @param string $name
+        * @return void
         */
        public function setName($name) {
                $this->name = $name;
        }
 
        /**
+        * Get name
+        *
         * @return string
         */
        public function getName() {
@@ -131,13 +149,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set title
+        *
         * @param string $title
+        * @return void
         */
        public function setTitle($title) {
                $this->title = $title;
        }
 
        /**
+        * Get Title
+        *
         * @return string
         */
        public function getTitle() {
@@ -145,13 +168,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set Link
+        *
         * @param string $link
+        * @return void
         */
        public function setLink($link) {
                $this->link = $link;
        }
 
        /**
+        * Get Link
+        *
         * @return string
         */
        public function getLink() {
@@ -159,13 +187,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set Description
+        *
         * @param string $description
+        * @return void
         */
        public function setDescription($description) {
                $this->description = $description;
        }
 
        /**
+        * Get Description
+        *
         * @return string
         */
        public function getDescription() {
@@ -173,13 +206,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set Navigation Component Id
+        *
         * @param string $navigationComponentId
+        * @return void
         */
        public function setNavigationComponentId($navigationComponentId) {
                $this->navigationComponentId = $navigationComponentId;
        }
 
        /**
+        * Get Navigation Component Id
+        *
         * @return string
         */
        public function getNavigationComponentId() {
@@ -187,13 +225,18 @@ class Typo3_Domain_Model_BackendModule {
        }
 
        /**
+        * Set onClick
+        *
         * @param string $onClick
+        * @return void
         */
        public function setOnClick($onClick) {
                $this->onClick = $onClick;
        }
 
        /**
+        * Get onClick
+        *
         * @return string
         */
        public function getOnClick() {
index c08e623..0a44d37 100644 (file)
@@ -47,13 +47,18 @@ class Typo3_ModuleStorage implements t3lib_Singleton {
        }
 
        /**
+        * Set Entries
+        *
         * @param \SplObjectStorage $entries
+        * @return void
         */
        public function setEntries($entries) {
                $this->entries = $entries;
        }
 
        /**
+        * Get Entries
+        *
         * @return \SplObjectStorage
         */
        public function getEntries() {
@@ -61,7 +66,10 @@ class Typo3_ModuleStorage implements t3lib_Singleton {
        }
 
        /**
+        * Attach Entry
+        *
         * @param Typo3_Domain_Model_BackendModule $entry
+        * @return void
         */
        public function attachEntry(Typo3_Domain_Model_BackendModule $entry) {
                $this->entries->attach($entry);
index 7a09237..c72cdc0 100644 (file)
@@ -40,7 +40,7 @@ class Typo3_Utility_BackendModuleUtility {
        protected $moduleMenu;
 
        /**
-        * @var Typo3_Repository_BackendModuleRepository
+        * @var Typo3_Domain_Repository_BackendModuleRepository
         */
        protected $moduleMenuRepository;
 
@@ -72,8 +72,8 @@ class Typo3_Utility_BackendModuleUtility {
        /**
         * Creates the module menu object structure from the raw data array
         *
-        * @see class.modulemenu.php getRawModuleData()
         * @param array $rawModuleData
+        * @see class.modulemenu.php getRawModuleData()
         * @return void
         */
        protected function convertRawModuleDataToModuleMenuObject(array $rawModuleData) {
@@ -93,10 +93,10 @@ class Typo3_Utility_BackendModuleUtility {
         * Creates a menu entry object from an array
         *
         * @param array $module
-        * @return Typo3_BackendModule
+        * @return Typo3_Domain_Model_BackendModule
         */
        protected function createEntryFromRawData(array $module) {
-               /** @var $entry Typo3_BackendModule */
+               /** @var $entry Typo3_Domain_Model_BackendModule */
                $entry = t3lib_div::makeInstance('Typo3_Domain_Model_BackendModule');
                if (!empty($module['name']) && is_string($module['name'])) {
                        $entry->setName($module['name']);
@@ -126,8 +126,8 @@ class Typo3_Utility_BackendModuleUtility {
        }
 
        /**
-        * Creates the "third level" menu entries (submodules for the info module for example)
-        * from the TBE_MODULES_EXT array
+        * Creates the "third level" menu entries (submodules for the info module for
+        * example) from the TBE_MODULES_EXT array
         *
         * @return void
         */