The Export menu of the content tree #

Exponential 6.0.15 adds an Export submenu to the Advanced submenu of the administration's context menus: the content tree's menu and the "…" menu of each row in the sub-items list, and the same entries are in the menu of the node view's Import/Export button. Both use the same Advanced menu (popupmenu/popup_sub_advance_menu.tpl), so the entries are the same in both places. The menu exists in design/admin4 (and admin4l, which falls back to it), design/admin (an identical copy), and the adminui design of exp_adminui (which uses admin4's templates).

Every entry opens the form of its tool filled in for the item. Nothing is exported from the menu: no entry submits a form, and no entry URL writes content or starts a job. The user checks the form and starts the export there.

The entries #

The wizard's "Related objects" choice is not offered as an entry: the content object package handler does not read it (the relations of an object are exported with its attributes either way).

Entry parameters #

package/create #

package/create/(creator)/ezcontentobject/(node)/<node id>[/(subtree)/1][/(classes)/0|1][/(versions)/current|all]

• creator must be ezcontentobject (the only wizard with an entry); node a node id, 1 to 2147483647 in plain digits; subtree 0 or 1 (default 0: the node alone); classes and versions preset the second step.
• Any other value answers "not available". A node that does not exist answers "not available", one the user cannot read "access denied", and so does a user without the policies below.
• The wizard starts again (its session data is replaced) with the node or subtree on its first step. The package is made only when the user goes through the steps. The checks are in eZContentObjectPackageCreator::entryParameters() and ::currentUserCanExportContent(); the view is kernel/private/classes/views/package/create.php.

xrowextract/csv (xrowextract 2.5.11) #

xrowextract/csv/(node)/<node id>[/(scope)/list|tree][/(class)/<class id>][/(columns)/all|migration]

• scope defaults to tree (the subtree); without class the form chooses as before (export.ini DefaultClassID, else the class with the most objects); without columns the user's saved columns for the class stay.
• The form's saved settings are filled in (node, scope, class; filters and offset cleared; output settings kept) and the view redirects to xrowextract/csv. Invalid values and a class export.ini ExportClasses does not offer answer "not available", a node the user cannot read "access denied". Code: XrowExtractEntry.
• xrowextract/subtree_classes/<node id> (policy xrowextract/csv) answers JSON for the "Subtree of class" list: { node, classes: [ { id, identifier, name, count } ], more, total }, counted with the user's read access; a node that is not there or not readable answers 404.

Who sees what #

• The package entries: fetch( 'package', 'content_export_access' ), true for a user with the policies package/create (a CreatorType limitation must include ezcontentobject, a Type limitation contentobject) and package/export (to download the package; a Type limitation must include contentobject).
• The CSV entries: the policy xrowextract/csv.
• Export is shown only when it has an entry for the user; an Editor (no package or xrowextract policies) sees no change. The tree and the sub-items list show only items the user can read, and every entry URL checks the node again.
• package.ini [ExtensionExportSettings] (exporting extensions as packages, off by default, #198) does not apply: content packages are made by the content object wizard, which it does not switch off.

Adding entries from an extension #

admininterface.ini [AdditionalMenuSettings]:

ExportMenuTemplateArray[]=popupmenu/myextension_export_menu.tpl        # export items (both menus)
ExportSubMenuTemplateArray[]=popupmenu/myextension_export_submenus.tpl   # their submenus, after each menu
ImportExportMenuTemplateArray[]=popupmenu/myextension_import_menu.tpl    # import and job items (Import/Export only)

An item template checks its own policy and outputs nothing for a user without it, adds its URLs to menuArray[$menu_id]['elements'] (with %nodeID%), names its items $item_prefix-…, gives a submenu the depth $sub_menu_depth, and opens a form, never an export or an import. A submenu whose items are known only when it opens sets menuArray[id]['onshow'] = function( menu, values, refresh ): ezpopupmenu.js calls it when the submenu opens; the function fills the menu (as text, never markup from data) and calls refresh(), which gives the new items their roles and places the menu again. xrowextract's xrowextract-exportmenu.js is the example.

The Import/Export button of the node view #

The node view's actions have an Import/Export button after Upload and before Move (design/admin4, admin4l through it, design/admin; in exp_adminui an entry of the toolbar's "…" menu, after Upload). It opens a menu with:

• the export entries of Advanced > Export (the same definition, popupmenu/popup_export_items.tpl, see below);
• Import into this item… (xrowextract 2.5.12, policy xrowextract/import): xrowextract/import with the item as the target, only on a container below which the user may create content (the view checks it again);
• Export and import jobs, Export history and Schedules (policies xrowextract/jobs, /history, /schedule): xrowextract's pages, which list the user's jobs, runs and schedules (every user's with xrowextract/all_jobs), not only this item's.

The button (node/view/import_export_button.tpl, identical in design/admin and design/admin4) is shown only for a published object (never on a draft or the edit pages) and only when the shared definition has an entry for the user: an Editor sees nothing, a user with xrowextract/csv only sees the CSV entries. It is an .a4-btn menu button (aria-haspopup="menu", aria-expanded) with the Bootstrap icon arrow-down-up: Enter or Space open the menu with the focus on its first entry, Escape closes it and returns to the button. The menu is popupmenu/popup_import_export_menu.tpl (a top-level menu of the page's popup menus); the button gives it %nodeID% and %canImport%, and the Import entry is shown only when %canImport% is 1 (ezpopupmenu.js element option shown_if).

xrowextract/import (xrowextract 2.5.12) #

xrowextract/import/(parent)/<node id>

The import form starts with that node as its target (kept for the session until another is chosen) and the view redirects to the form; nothing is imported before the user uploads a file, checks the preview and applies it. A node that does not exist answers "not available"; one the user cannot read, that is not a container or below which the user may not create content answers "access denied" (XrowExtractEntry::importRefusal()).

One definition for both menus #

popupmenu/popup_export_items.tpl holds the entries; the context menus' Export submenu and the Import/Export menu include it with menu_id, item_prefix, sub_menu_depth and with_import, and the button includes it to tell whether it has an entry. Extension templates of ExportMenuTemplateArray[], ExportSubMenuTemplateArray[] and ImportExportMenuTemplateArray[] (import and job entries, the Import/Export menu only) receive the same parameters and register their URLs in menuArray[$menu_id]; a submenu of an entry is <menu id>Classes-style, one per menu.

Keyboard and placement #

The submenus follow the menu pattern of #165: Right, Enter or Space open a submenu and move the focus into it, Left or Escape close it and return the focus to its item; items with a submenu have aria-haspopup="menu" and aria-expanded. A nested submenu opens beside its parent on the side with room and is moved inside the window when neither side has room (960px at 200 % zoom, phones); it moves up from the bottom edge and scrolls when it is taller than the window (_horizontalSubPlace(), _subVerticalPlace() in ezpopupmenu.js).

Tests: tests/tests/kernel/classes/expContentExportEntryTest.php, tests/tests/design/AdminContextMenuNestedSubmenuTest.php, xrowextract's tests/unit/EntryTest.php.