[TASK] Backend toolbar interface documentation 80/34780/3
authorChristian Kuhn <lolli@schwarzbu.ch>
Sat, 29 Nov 2014 19:46:10 +0000 (20:46 +0100)
committerFrank Nägler <typo3@naegler.net>
Sat, 29 Nov 2014 20:02:57 +0000 (21:02 +0100)
Add .rst file for toolbar refactoring works and hint about
future changes of checkAccess() method.

Releases: master
Resolves: #63431
Change-Id: Ibbe019a4e204d9e99e0f722630395c010520ee8e
Reviewed-on: http://review.typo3.org/34780
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Reviewed-by: Frank Nägler <typo3@naegler.net>
Tested-by: Frank Nägler <typo3@naegler.net>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/backend/Classes/Toolbar/ToolbarItemInterface.php
typo3/sysext/core/Documentation/Changelog/master/Breaking-63431-BackendToolbarRefactored.rst [new file with mode: 0644]

index 1b475e3..f99cc51 100644 (file)
@@ -24,6 +24,7 @@ interface ToolbarItemInterface {
 
        /**
         * Checks whether the user has access to this toolbar item
+        * @TODO: Split into two methods a permission method and a "hasContent" or similar
         *
         * @return boolean TRUE if user has access, FALSE if not
         */
@@ -61,7 +62,7 @@ interface ToolbarItemInterface {
         *     'data-foo' => '42',
         * )
         *
-        * @return string List item HTML attibutes
+        * @return string List item HTML attributes
         */
        public function getAdditionalAttributes();
 
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-63431-BackendToolbarRefactored.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-63431-BackendToolbarRefactored.rst
new file mode 100644 (file)
index 0000000..053a83a
--- /dev/null
@@ -0,0 +1,32 @@
+=============================================
+Breaking: #63431 - Backend toolbar refactored
+=============================================
+
+Description
+===========
+
+The upper right backend toolbar was refactored with TYPO3 CMS 7.0. A new PHP interface
+and a new registration was introduced.
+
+Impact
+======
+
+Extensions not adapted to the new interface will not show up in the toolbar anymore, but
+will not throw a fatal PHP error.
+
+Method BackendController::addToolbarItem() is deprecated.
+
+Affected installations
+======================
+
+If a TYPO3 CMS instance uses extensions based on the old interface and registration, the
+according items will vanish from the toolbar.
+
+Migration
+=========
+
+Extensions must implement the new interface \TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface
+and must register in $GLOBALS['TYPO3_CONF_VARS']['BE']['toolbarItems'].
+
+Warning: The new interface is not 100% finished, method checkAccess() will probably be
+substituted by two other methods in later TYPO3 CMS versions.