Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

Patterns in kernel/classes/ini

Every class, view, fetch function, operator and plugin point of kernel/classes/ini with its design patterns.

Download as PDF

Address: https://doc.exponential.earth/learninminutes/exphelp/viewer/standards/patterns/area-kernel-classes-ini.md

Patterns in kernel/classes/ini

Note

This page is generated from the source code by php bin/php/exppatterncatalogue.php --write. Do not edit it by hand: change the code or the generator, then run the command again. How the patterns are recognized: the pattern catalogue.

Every class, interface and trait of kernel/classes/ini with the patterns it was recognized as, followed by the module views, policy functions, fetch functions, template operators, cronjobs, event hooks and INI plugin points of the area. All patterns.

Classes (32)

ClassKindPatternsFileDescription
expIniActioninterfaceInterface (contract)kernel/classes/ini/actions/expiniaction.php:15One action of the exp:ini command (get, set, add, rem, ...).
expIniActionActionsclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionactions.php:14exp:ini actions: the actions of the command, the built-in ones and those extensions register in ini.ini [IniCommandSettings] Actions[], with their al…
expIniActionAddclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionadd.php:14exp:ini add: appends a value to an array (Variable[]=value) in one scope's file, creating the file and the block when they are missing (unless --no-c…
expIniActionBaseabstract class implements expIniActionTemplate Method / abstract base classkernel/classes/ini/actions/expiniactionbase.php:15What the built-in exp:ini actions share: the three describing methods from class constants, the printing of a value as INI lines, and the small check…
expIniActionClearclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionclear.php:13exp:ini clear: writes the array reset line Variable[] in one scope's file, so the values the files loaded before it give are dropped and only what fo…
expIniActionCopyclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactioncopy.php:15exp:ini copy: copies a setting from one scope's file to another's: a plain variable or a hash entry is set to the same value, a whole array is writte…
expIniActionGetclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionget.php:14exp:ini get: the value in effect (every file merged in load order, for the current siteaccess or the one of -s) or, with a scope, the value that scop…
expIniActionListclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionlist.php:14exp:ini list: the blocks of an INI file, or the variables of one block, in effect (every file merged, for the current siteaccess) or as one scope's f…
expIniActionMoveclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionmove.php:16exp:ini move: moves one block (with its comments and blank lines, in order) or every block of a file from one scope to another, typically from settin…
expIniActionMoveAllclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionmoveall.php:15exp:ini move-all: moves every INI file of a scope (or those --files names) into another scope, block by block, one transaction per file as exp:ini mo…
expIniActionRegistryclassFactory and static factory methods, Registrykernel/classes/ini/actions/expiniactionregistry.php:22The actions of the exp:ini command and the scope providers of the settings editor, read from ini.ini [IniCommandSettings]:
expIniActionRemclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionrem.php:14exp:ini rem (alias remove): removes a variable from one scope's file, or one value of an array, or one entry of a hash.
expIniActionScopesclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionscopes.php:14exp:ini scopes: the scopes this installation has (global, default, every siteaccess, every extension and the extension siteaccess directories, and th…
expIniActionSetclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionset.php:14exp:ini set: sets a plain variable (Variable=value) or a hash entry (Variable[key]=value) in one scope's file, creating the file and the block when t…
expIniActionToggleclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactiontoggle.php:14exp:ini toggle: flips a switch in one scope's file the way the setting writes it: enableddisabled, truefalse, yesno, onoff, 10 (the case is kept).
expIniActionWhereclass extends expIniActionBaseINI plugin point (extension point)kernel/classes/ini/actions/expiniactionwhere.php:14exp:ini where: every file that sets a variable, in the order eZINI loads them (the last one wins for a plain value, arrays add up unless a file reset…
expIniCommandclassCommand (console, scripts, cronjobs), Utility (static helper)kernel/classes/ini/actions/expinicommand.php:15The exp:ini command without its script: splitting the command line, the help texts, finding the action in the registry, running it with an expIniComm…
expIniCommandContextclass–kernel/classes/ini/actions/expinicommandcontext.php:22What an exp:ini action is handed: the arguments after the action's name, the options, the output (text, or one JSON object with --json), the settings…
expIniCoreScopeProviderclass implements expIniScopeProviderINI plugin point (extension point), Strategy / handlerkernel/classes/ini/expinicorescopeprovider.php:16global (settings/override), default (settings/, the shipped defaults, not writable by policy) and one scope per siteaccess: every directory in settin…
expIniEditorclassFactory and static factory methods, Registrykernel/classes/ini/expinieditor.php:27The INI editor.
expIniExceptionclass extends ExceptionException hierarchy, Factory and static factory methodskernel/classes/ini/expiniexception.php:15An error of the INI editor.
expIniExtensionScopeProviderclass implements expIniScopeProviderINI plugin point (extension point), Strategy / handlerkernel/classes/ini/expiniextensionscopeprovider.php:14extension: for every directory in extension/ (active or not; the label says which) and extension::siteaccess: for every extension//settings/siteacces…
expIniLocatorclassUtility (static helper)kernel/classes/ini/expinilocator.php:25Every file that sets a variable, in the order eZINI loads them for a siteaccess, and the effective value.
expIniMoverclass–kernel/classes/ini/actions/expinimover.php:20Moves settings blocks from one scope's file to another's, for exp:ini move and move-all: a block with its comments and blank lines in order, every bl…
expIniScopeclass–kernel/classes/ini/expiniscope.php:22One INI scope: a settings directory and the rule for the file name in it.
expIniScopeProviderinterfaceInterface (contract), Strategy / handlerkernel/classes/ini/expiniscopeprovider.php:20A source of INI scopes (places an INI file can be written).
expIniWriterclassFactory and static factory methodskernel/classes/ini/expiniwriter.php:26One INI file as a list of lines, read exactly the way eZINI::parseFile() reads it, and changed one line at a time: comments, blank lines, the order o…
expIniWriteResultclass–kernel/classes/ini/expiniwriteresult.php:13The outcome of one expIniEditor::save().
expSettingsChainclassChain of Responsibility, Factory and static factory methodskernel/classes/ini/expsettingschain.php:32The override chain of one INI file, built once from the files eZINI reads for it, in eZINI's own order.
expSettingsPageclassUtility (static helper)kernel/classes/ini/expsettingspage.php:18The rows, figures, searches and comparisons of the settings pages, and what a write is followed by.
expSettingsSecretRuleclassFactory and static factory methodskernel/classes/ini/expsettingssecretrule.php:30The rule the settings pages (settings/view, settings/edit) mask values by.
expSettingsTargetclassUtility (static helper)kernel/classes/ini/expsettingstarget.php:19The checks between a request and a settings file.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x