The Automad class includes all methods and properties regarding the site, structure and pages. A Automad object is the "main" object. It consists of many single Page objects, the Shared object and holds also additional data like the Filelist and Pagelist objects.
The Cache class holds all methods for evaluating, reading and writing the HTML output and the Automad object from/to AM_DIR_CACHE. Basically there are three things which get cached - the latest modification time of all the site's files and directories (site's mTime), the page's HTML and the Automad object.
|Config||The Config class.|
|Context||The Context represents the current page within statements (loops) or just the requested page.|
The Debug class holds all methods to help debugging while development. The output of all the contained methods can be activated/deactivated with defining the AM_DEBUG_ENABLED constant. All logged information will be stored in $buffer as JS's console.log() items.
The Extension class provides an interface for calling an extension from a template file. There are two options for autoloading extension classes:
|Filelist||The Filelist object represents a set of files based on a file pattern depending on the current context.|
|FileSystem||The FileSystem class.|
|Image||The Image object represents a resized (and cropped) copy of a given image.|
The Page class holds all properties and methods of a single page. A Page object describes an entry in the collection of all pages in the Automad class. Basically the Automad object consists of many Page objects.
|Pagelist||A Pagelist object represents a set of Page objects (matching certain criterias).|
|Parse||The Parse class holds all parsing methods.|
|Pipe||The Pipe class handles the chain of processes to manipulate variable values.|
|Regex||The Regex class holds all methods relating regular expressions.|
The Resolve class holds all methods to modulate URLs and file paths. Since all page URLs are not URLs to real directories, all non-absolute links and file paths have to be resolved, to point to a valid location. For example a relative file name to an image wouldn't be a valid link, since the URL of the page is not the real file system path to the page's files.
The Runtime class handles all variables generated during runtime. Those variables are created by Automad at runtime and independent from the Context and Shared objects.
|Selection||The Selection class holds all methods to filter and sort the collection of pages and return them as a new selection.|
|SessionData||The SessionData class handles setting and getting items of $_SESSION['data'].|
|Shared||The Shared class represents a collection of all shared site-wide data.|
|Sitemap||The Sitemap class handles the generating process for a site's sitemap.xml.|
|Str||The Str class holds all string methods.|
|Toolbox||The Toolbox class holds all methods to be used within the template files.|
|View||The View class holds all methods to render the current page using a template file.|