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 extension/ezodf

Every class, view, fetch function, operator and plugin point of extension/ezodf with its design patterns.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/standards/patterns/area-extension-ezodf.md

On this page

Patterns in extension/ezodf

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 extension/ezodf 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 (39)

ClassKindPatternsFileDescription
expOdfAiAssistclassUtility (static helper)extension/ezodf/classes/converter/expodfaiassist.php:20AI assist of the import (expai, opt-in): for an imported document, a summary for the intro and keywords, as suggestions a person applies on the batch…
expOdfBatchclassFactory and static factory methodsextension/ezodf/classes/converter/expodfbatch.php:25One import of documents: files, a folder (its tree), ZIP archives and URLs, uploaded on the Import documents page.
expOdfCleanupclassUtility (static helper)extension/ezodf/classes/converter/expodfcleanup.php:15Removes what ezodf leaves behind: work and spool directories of conversions (older than an hour: a conversion never takes that long), uploaded batche…
expOdfConverterclassStrategy / handler, Utility (static helper)extension/ezodf/classes/converter/expodfconverter.php:29Converts documents.
expOdfConverterAdminclassUtility (static helper)extension/ezodf/classes/converter/expodfconverteradmin.php:14The data and the actions of the Document converter page (ezodf/converter) and its live state (ezodf/converterstatus).
expOdfConverterExceptionclass extends RuntimeExceptionException hierarchyextension/ezodf/classes/converter/expodfconverterexception.php:14A conversion that failed.
expOdfConverterTestclassUtility (static helper)extension/ezodf/classes/converter/expodfconvertertest.php:15The test conversions of the Document converter page: each bundled sample (share/samples) is converted with the converter as it is set up (its backend…
expOdfDocumentsAdminclassUtility (static helper)extension/ezodf/classes/converter/expodfdocumentsadmin.php:13The data of the Import documents, batch and runs pages (ezodf/import, ezodf/batch, ezodf/runs).
expOdfExporterclassUtility (static helper)extension/ezodf/classes/converter/expodfexporter.php:18Items out as documents.
expOdfFilterCatalogueclassDecorator / filter, Utility (static helper)extension/ezodf/classes/converter/expodffiltercatalogue.php:16The import and export filters of a LibreOffice installation, read from its share/registry/*.xcd files (the type detection's Filters and Types), so th…
expOdfHtmlToOdtclassFactory and static factory methodsextension/ezodf/classes/readers/expodfhtmltoodt.php:47Writes the HTML of expOdfReaders as an ODT text that ezodf's ODT parser (eZOOImport) imports:
expOdfImportDocumentFeedSourceclass extends expOdfImportDocumentUrlsSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportdocumentfeedsource.php:18"Documents of a feed" of 7x SQLI Import: an RSS or Atom feed whose items link to documents (enclosures, or links ending in a document extension: a pu…
expOdfImportDocumentSourceclass extends expImportJsonSourceINI plugin point (extension point)extension/ezodf/classes/sqliimport/expodfimportdocumentsource.php:30The document formats of 7x SQLI Import (sqliimport 2.x), declared by ezodf in its kernelservices.ini with the tag sqliimport.source; loaded only by s…
expOdfImportDocumentUrlsSourceclass extends expOdfImportDocumentSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportdocumenturlssource.php:16"Documents from URLs" of 7x SQLI Import: a list of addresses of documents (one per line).
expOdfImportGoogleDriveSourceclass extends expOdfImportDocumentSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportgoogledrivesource.php:33"Documents in a Google Drive folder" of 7x SQLI Import: the documents of a Drive folder (in My Drive or a shared drive) and of its sub folders down t…
expOdfImportHttpclassUtility (static helper)extension/ezodf/classes/sqliimport/expodfimporthttp.php:27The HTTP requests of the remote document sources of 7x SQLI Import (WebDAV and Nextcloud, Google Drive, OneDrive and SharePoint), with the address po…
expOdfImportMailboxDocumentsSourceclass extends expOdfImportDocumentSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportmailboxdocumentssource.php:31"Documents attached to e-mails (IMAP)" of 7x SQLI Import: the document attachments of the messages of an IMAP mailbox (a submissions address, a press…
expOdfImportOneDriveSourceclass extends expOdfImportDocumentSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportonedrivesource.php:36"Documents in a OneDrive or SharePoint folder" of 7x SQLI Import: the documents of a folder of a OneDrive for Business drive or a SharePoint document…
expOdfImportWebdavSourceclass extends expOdfImportDocumentSourceINI plugin point (extension point), Utility (static helper)extension/ezodf/classes/sqliimport/expodfimportwebdavsource.php:33"Documents in a WebDAV or Nextcloud folder" of 7x SQLI Import: the documents of a folder on a WebDAV server (Nextcloud, ownCloud, a SharePoint WebDAV…
expOdfInstallationclassFactory and static factory methodsextension/ezodf/classes/converter/expodfinstallation.php:22A LibreOffice installation ezodf can use:
expOdfInstallerclass–extension/ezodf/classes/converter/expodfinstaller.php:30The one-click installation of LibreOffice, without root: the official build of The Document Foundation is downloaded into var//ezodf/libreoffice/, ve…
expOdfJobsclassUtility (static helper)extension/ezodf/classes/converter/expodfjobs.php:24ezodf's background work, started from the administration and never run inside a web request:
expOdfPathsclassUtility (static helper)extension/ezodf/classes/converter/expodfpaths.php:24Where ezodf 7 keeps its files, all below the site's var directory (var//ezodf/):
expOdfPhpConverterclassFactory and static factory methods, Strategy / handler, Utility (static helper)extension/ezodf/classes/converter/expodfphpconverter.php:25The last fallback of the converter: PHP only, no LibreOffice.
expOdfQueueHandlerclass extends expQueueHandlerBaseINI plugin point (extension point), Strategy / handlerextension/ezodf/classes/converter/expodfqueuehandler.php:14The expqueue handler of ezodf's jobs (expqueue.ini [JobType_ezodf.*]); the work itself is in expOdfJobs::run().
expOdfReadersclassFactory and static factory methodsextension/ezodf/classes/readers/expodfreaders.php:39Reads documents without LibreOffice and turns them into a safe HTML fragment plus the images it holds:
expOdfRemoteFetcherclassUtility (static helper)extension/ezodf/classes/converter/expodfremotefetcher.php:24Downloads a document from a URL an editor gave, without letting the URL reach the server's own network (server-side request forgery):
expOdfRemoteServerclassUtility (static helper)extension/ezodf/classes/converter/expodfremoteserver.php:22A conversion service elsewhere, set on the Document converter page (converter.remote_url, remote_kind, an optional user and password for HTTP basic a…
expOdfSandboxclassUtility (static helper)extension/ezodf/classes/converter/expodfsandbox.php:23Runs LibreOffice (and ezodf's worker script) in a sandbox:
expOdfServerclassUtility (static helper)extension/ezodf/classes/converter/expodfserver.php:23The conversion server: one or more long-lived headless LibreOffice processes, each supervised by ezodf's worker script (bin/ezodfworker.py) inside th…
expOdfSettingsclassUtility (static helper)extension/ezodf/classes/converter/expodfsettings.php:22The settings of ezodf 7 as the administration changes them: the settings pages write var//ezodf/settings.json (the extension's own store, never setti…
Exponential\View\Extension\Ezodf\Ezodf\Exportclass extends ModuleViewModule view (Page Controller)extension/ezodf/classes/runnable/views/ezodf/export.php:71The code of extension/ezodf/modules/ezodf/export.php, moved into a class (#207 stage 1).
Exponential\View\Extension\Ezodf\Ezodf\Importclass extends ModuleViewModule view (Page Controller)extension/ezodf/classes/runnable/views/ezodf/import.php:44The code of extension/ezodf/modules/ezodf/import.php, moved into a class (#207 stage 1).
ezodfInfoclassValue object / structextension/ezodf/ezinfo.php:12–
eZOOConverterclassStrategy / handlerextension/ezodf/classes/ezooconverter.php:41–
eZOOGeneratorclassBuilderextension/ezodf/classes/ezoogenerator.php:41–
eZOOImportclass–extension/ezodf/classes/ezooimport.php:41–
eZOpenofficeUploadHandlerclass extends eZContentUploadHandlerStrategy / handlerextension/ezodf/uploadhandlers/ezopenofficeuploadhandler.php:41–
eZRESTODFHandlerclass extends eZRESTBaseHandlerINI plugin point (extension point), Strategy / handlerextension/ezodf/classes/ezrestodfhandler.php:46–

Module views (11)

ViewScriptPolicy functionsDefined in
/ezodf/importimport.phpimportextension/ezodf/modules/ezodf/module.php:29
/ezodf/exportexport.phpexportextension/ezodf/modules/ezodf/module.php:37
/ezodf/uploadupload.phpimportextension/ezodf/modules/ezodf/module.php:45
/ezodf/batchbatch.phpimportextension/ezodf/modules/ezodf/module.php:50
/ezodf/batchstatusbatchstatus.phpimportextension/ezodf/modules/ezodf/module.php:56
/ezodf/runsruns.phpimportextension/ezodf/modules/ezodf/module.php:61
/ezodf/exportfileexportfile.phpexportextension/ezodf/modules/ezodf/module.php:67
/ezodf/exportstatusexportstatus.phpexportextension/ezodf/modules/ezodf/module.php:72
/ezodf/converterconverter.phpconverterextension/ezodf/modules/ezodf/module.php:77
/ezodf/converterstatusconverterstatus.phpconverterextension/ezodf/modules/ezodf/module.php:83
/ezodf/converterfileconverterfile.phpconverterextension/ezodf/modules/ezodf/module.php:88

Policy functions (3)

FunctionLimitationsDefined in
ezodf/import–extension/ezodf/modules/ezodf/module.php:94
ezodf/export–extension/ezodf/modules/ezodf/module.php:95
ezodf/converter–extension/ezodf/modules/ezodf/module.php:97

Cronjob parts (1)

CronjobFileDescription
ezodf_keepaliveextension/ezodf/cronjobs/ezodf_keepalive.phpCron part of ezodf: keeps the conversion server running when the administration turned it on (after a reboot or a crash), and removes work files, upl…

INI plugin points (14)

SettingClassSet in
[JobType_ezodf.install] HandlerexpOdfQueueHandlerextension/ezodf/settings/expqueue.ini.append.php:5
[JobType_ezodf.server] HandlerexpOdfQueueHandlerextension/ezodf/settings/expqueue.ini.append.php:12
[JobType_ezodf.test] HandlerexpOdfQueueHandlerextension/ezodf/settings/expqueue.ini.append.php:19
[JobType_ezodf.import] HandlerexpOdfQueueHandlerextension/ezodf/settings/expqueue.ini.append.php:26
[JobType_ezodf.export] HandlerexpOdfQueueHandlerextension/ezodf/settings/expqueue.ini.append.php:33
[RESTSettings] HandlerList[]eZRESTODFHandlerextension/ezodf/settings/ezrest.ini.append.php:4
[Service_transfer.ezodf] ClassexpKernelTransferToolextension/ezodf/settings/kernelservices.ini.append.php:9
[Source_documents] ClassexpOdfImportDocumentSourceextension/ezodf/settings/sqliimport.ini.append.php:16
[Source_document_urls] ClassexpOdfImportDocumentUrlsSourceextension/ezodf/settings/sqliimport.ini.append.php:19
[Source_document_feed] ClassexpOdfImportDocumentFeedSourceextension/ezodf/settings/sqliimport.ini.append.php:22
[Source_webdav] ClassexpOdfImportWebdavSourceextension/ezodf/settings/sqliimport.ini.append.php:25
[Source_google_drive] ClassexpOdfImportGoogleDriveSourceextension/ezodf/settings/sqliimport.ini.append.php:28
[Source_onedrive] ClassexpOdfImportOneDriveSourceextension/ezodf/settings/sqliimport.ini.append.php:31
[Source_mailbox_documents] ClassexpOdfImportMailboxDocumentsSourceextension/ezodf/settings/sqliimport.ini.append.php:34

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