Core Documentation

Here you will find a guide to the generated core documentation for Omeka S's core classes. Each link refers to a representation of the docblock documentation for top namespaces within Omeka S, found in application/src.

Api

Essential classes for using and understanding the Omeka S API, including Adapters (for interacting with the database) and Representations (for reading data for display). Many of the classes here will match with classes under Entity and Controller.

Authentication

Classes for authenticating users and establishing permissions to the storage. See also Zend\Authentication

Controller

Essential classes negotiating between requests, the database, and passing objects on to Views. Many of the classes here will match with classes under Api and Entity.

DataType

Classes defining Omeka S datatypes (literals, URIs, and internal references), and handling their form elements and display.

Db

Classes defining how Omeka S interacts with the database.

Entity

Essential classes defining Omeka S objects (Items, Item Sets, etc) and how they interact via Doctrine.

File

Classes defining File data, including derivatives and their storage data.

Form

Subclasses of Zend\Form\Form used in Views for entering data.

I18n

Class for creating and displaying translations of admin view content.

Installation

Classes that handle the installation of Omeka S.

Job

Classes that handle dispatching background jobs, such as importers or other long-running processes.

Log

Class to handle logging for background jobs (Zend handles the logging to the usual location in logs/application.log).

Media

Classes defining how Media (images, YouTube videos, HTML, etc.) are created and displayed.

Module

Classes for the installation, status, reading .ini files, etc. for addon modules for Omeka S.

Mvc

Top level classes for routing and handling requests. See also Zend\Mvc

Permissions

Classes defining the Access Control List behavior for Omeka S. See also Zend\Permissions.

Service

Classes for creating Omeka S objects and injecting the appropriate dependencies. See also Zend\ServiceManager

ServiceManager

Class to manage the creation of Services. See also Zend\ServiceManager

Session

Class to handle browser sessions.

Settings

Classes to handle basic settings for Omeka S, such as site settings, installation settings, and user settings.

Site

Essential classes for defining things like Site structure and navigation.

Stdlib

Utility classes used throughout Omeka S for basic tasks, like sending email, handling error messages, pagination, etc.

Test

Classes for the core test suite, found in /test.

View

Mostly helper classes used to create content display, but also some classes for the JSON-LD output from the API. See also Zend\View