kernelservices.ini [Service_transfer.registry] #

The block [Service_transfer.registry] of settings/kernelservices.ini, with 5 setting(s).

The transfer registry (doc/eng-us/features/6.0/transfer-registry.md): every import and export tool declares itself
in a block tagged transfer.tool, the kernel's below, an extension's in its own
settings/kernelservices.ini.append.php. Every link to a tool reads the registry: the "Looking for…?" boxes, the
entries of the content view's Import/Export menu and of the class pages, the "Import and export" list of the Setup
menu and of the tools' left menus, the admin search's tool suggestions, and the context help. A tool whose
extension is not active, whose module does not exist or that the user may not use is never shown.

Class=expKernelTransferTool, Factory=expKernelTransferTool::fromSettings, Arguments[]=<the block's id>,
Scope=worker, Tags[]=transfer.tool, and:
Description one sentence: what it is for
Name its name in lists
Direction import, export or both
Scopes[] site, subtree, object, class, data (records that are not content: submissions, subscribers, logs)
Formats[] the file formats it reads or writes (CSV, XLSX, ezpkg ...)
EntryURL its main page; its first part is the tool's module
Permission module/function needed to use it; alternatives separated by "|"
Modules[] further modules whose pages belong to the tool
HelpPage its help page (a page id below doc/eng-us/, ext/<extension>/<path> for an extension's, #anchor allowed)
RoundTrip[] the ids of tools that read what it writes or write what it reads
Keywords[] task words the admin search finds it by (English and German)
Actions[] context|import or export|label|URL[|module/function]: an entry of a context. Contexts: node (any
published item), container (an item below which the user may create), class (a class page),
setup (the Setup pages); %nodeID%, %objectID%, %classID%, %classIdentifier% in the URL
Weight the order in lists (lower first, then by name; default 100)

Never edit settings/kernelservices.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/kernelservices.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/kernelservices.ini.append.php for one siteaccess,
• extension/<extension>/settings/kernelservices.ini.append.php in an extension (read when the extension is active).

Class #

Default: expKernelTransferRegistry.

<?php /* #?ini charset="utf-8"?
# settings/override/kernelservices.ini.append.php
[Service_transfer.registry]
Class=expKernelTransferRegistry
*/ ?>

Factory #

Default: expKernelTransferRegistry::fromContainer.

<?php /* #?ini charset="utf-8"?
# settings/override/kernelservices.ini.append.php
[Service_transfer.registry]
Factory=expKernelTransferRegistry::fromContainer
*/ ?>

Scope #

Default: worker.

<?php /* #?ini charset="utf-8"?
# settings/override/kernelservices.ini.append.php
[Service_transfer.registry]
Scope=worker
*/ ?>

Tags #

Default: a list of 1: kernel.core.

<?php /* #?ini charset="utf-8"?
# settings/override/kernelservices.ini.append.php
[Service_transfer.registry]
# an empty "Tags[]" first replaces the shipped list; without it the items are added
Tags[]
Tags[]=kernel.core
*/ ?>

Description #

Default: The transfer registry: the import and export tools of the installation (tag transfer.tool)..

<?php /* #?ini charset="utf-8"?
# settings/override/kernelservices.ini.append.php
[Service_transfer.registry]
Description=The transfer registry: the import and export tools of the installation (tag transfer.tool).
*/ ?>

Related #

• All blocks of kernelservices.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/kernelservices.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.