A

AppClass in namespace Automad
The App class instance takes care of running all required startup tests, initializing PHP sessions, setting up the autoloader, reading the configuration and displaying the final output for a request.
AutoloadClass in namespace Automad
The Autoload class.
AbstractBlockClass in namespace Automad\Blocks
The abstract base block.
AutomadClass in namespace Automad\Core
The Automad class includes all methods and properties regarding the site, structure and pages.
$Cache#automadObjectCachingIsEnabledProperty in class Cache
The status of the Automad object cache.
Cache::automadObjectCacheIsApproved() — Method in class Cache
Verify if the cached version of the Automad object is existing and still up to date.
FileUtils::allowedFileTypes() — Method in class FileUtils
Return an array with the allowed file types.
Resolve::absoluteUrlToDomain() — Method in class Resolve
Resolve absolute URLs (starting with a slash) to the domain.
Resolve::absoluteUrlToRoot() — Method in class Resolve
Resolve absolute URLs (starting with a slash) to root in case Automad is installed within a subdirectory.
AssetCollectionClass in namespace Automad\Engine\Collections
The extension asset collection class.
$AssetCollection#assetsProperty in class AssetCollection
A multidimensional array for .css and .js files.
SnippetCollection::add() — Method in class SnippetCollection
Add a snippet definition to the collection.
$Extension#assetsProperty in class Extension
The array of found assets.
$ContentProcessor#AutomadProperty in class ContentProcessor
The main Automad instance.
AbstractFeatureProcessorClass in namespace Automad\Engine\Processors\Features
The abstract feature processor class. All feature processors based on this class must implement a process() and a static syntaxPattern() method.
$AbstractFeatureProcessor#AutomadProperty in class AbstractFeatureProcessor
The main Automad instance.
$PostProcessor#AutomadProperty in class PostProcessor
The Automad instance.
PostProcessor::addCacheBustingTimestamps() — Method in class PostProcessor
Find all locally hosted assests and append a timestamp in order to avoid serving outdated files.
PostProcessor::addMetaTags() — Method in class PostProcessor
Add meta tags to the head of $str.
$TemplateProcessor#AutomadProperty in class TemplateProcessor
The main Automad instance.
$Runtime#AutomadProperty in class Runtime
The Automad object.
$Toolbox#AutomadProperty in class Toolbox
Automad object.
$View#AutomadProperty in class View
The main Automad instance.
$Composer#autoloaderProperty in class Composer
Composer autoloader within the temporary extraction directory.
$Theme#authorProperty in class Theme
The theme author.
AbstractCommandClass in namespace Automad\UI\Commands
The abstract base command class.
PageController::add() — Method in class PageController
Add page based on data in $_POST.
UIController::autocompleteJump() — Method in class UIController
Return the autocomplete values for a search field.
UIController::autocompleteLink() — Method in class UIController
Return the autocomplete values for a link field.
PageModel::add() — Method in class PageModel
Add page.
$SearchModel#AutomadProperty in class SearchModel
The Automad results.
SearchModel::appendFieldResults() — Method in class SearchModel
Append an item to a given array only in case it is an results.
$Response#autocompleteProperty in class Response
The output buffer for autocomplete JSON data.
FileSystem::appendSuffixToPath() — Method in class FileSystem
Append a suffix to a path just before the trailing slash.
FileSystem::appendSuffixToTitle() — Method in class FileSystem
Open a data text file under the given path, read the data, append a suffix to the title variable and write back the data.
Prefix::attributes() — Method in class Prefix
Replace the prefixes of UIkit classes and data attributes in a string.

B

BlocksClass in namespace Automad\Core
The Blocks class.
$Debug#bufferProperty in class Debug
Log buffer.
Toolbox::breadcrumbs() — Method in class Toolbox
Generate breadcrumbs to the current page, if the page's level is > 0 (not homepage / search results / page not found).
Update::backupCurrent() — Method in class Update
Move currently installed items to /cache/update/backup.
BlockSnippetArraysClass in namespace Automad\UI\Components\Header
The block snippet arrays as JS variable.
BreadcrumbsClass in namespace Automad\UI\Components\Nav
The breadcrumb component.
$Response#bufferProperty in class Response
The output buffer used by Composer commands.

C

AbstractBlock::classAttr() — Method in class AbstractBlock
Return a class attribute for the wrapping block element.
CodeClass in namespace Automad\Blocks
The code block.
$Automad#ContextProperty in class Automad
Automad's Context object.
$Automad#collectionProperty in class Automad
Array holding all the site's pages and the related data.
Automad::currentPageExists() — Method in class Automad
Tests wheter the currently requested page actually exists and is not an error page.
Automad::collectPages() — Method in class Automad
Searches $path recursively for files with the AM_FILE_EXT_DATA and adds the parsed data to $collection.
CacheClass in namespace Automad\Core
The Cache class holds all methods for evaluating, reading and writing the HTML output and the Automad object from/to AM_DIR_CACHE.
Cache::clear() — Method in class Cache
Clearing the cache is done by simply setting the stored Site's mTime to the current timestamp.
ConfigClass in namespace Automad\Core
The Config class.
ContextClass in namespace Automad\Core
The Context represents the current page within statements (loops) or just the requested page.
Debug::consoleLog() — Method in class Debug
Stop timer, calculate execution time, get user & server constants and return a console log item for every item in the buffer array.
FileUtils::caption() — Method in class FileUtils
Read a file's caption file and render contained markdown syntax.
$Filelist#ContextProperty in class Filelist
The Context.
Filelist::config() — Method in class Filelist
Configure the filelist.
$Image#cropProperty in class Image
Cropping parameter.
$Image#cropXProperty in class Image
The pixels to crop the image on the X-axis on both sides.
$Image#cropYProperty in class Image
The pixels to crop the image on the Y-axis on both sides.
Image::calculateSize() — Method in class Image
Calculate the size and pixels to crop for the generated image.
Image::createImage() — Method in class Image
Create a new (resized and cropped) image from the source image and save that image in AM_DIR_CACHE_IMAGES.
LegacyData::convert() — Method in class LegacyData
Convert legacy data such as layout information.
LegacyData::convertLayout() — Method in class LegacyData
Convert legacy layout properties to new tune api.
LegacyData::convertLists() — Method in class LegacyData
Convert legacy lists to new nested lists.
$Pagelist#collectionProperty in class Pagelist
The collection of all existing pages.
$Pagelist#ContextProperty in class Pagelist
The context.
$Pagelist#contextProperty in class Pagelist
In case $type is set to "children", the $context URL can be used as well to change the context from the current page to any page.
Pagelist::config() — Method in class Pagelist
Set or change the configuration of the pagelist and return the current configuration as array.
Parse::caption() — Method in class Parse
Please use FileUtils::caption() instead.
Parse::csv() — Method in class Parse
Split and trim comma separated string.
Extension::collectAssets() — Method in class Extension
Collect all assets (CSS & JS files) belonging to $class and store them in $this->assets.
$PatternAssembly#charClassAllVariablesProperty in class PatternAssembly
The character class to be used within a regex matching all allowed characters for all kine of variable names (content in .txt files, system variables ( :var ) and query string items ( ?var )).
$PatternAssembly#charClassTextFileVariablesProperty in class PatternAssembly
The character class to be used within a regex matching all allowed characters for variable names within .txt files.
PatternAssembly::csv() — Method in class PatternAssembly
Return a regex to match a sequence of comma separated values or variables.
ContentProcessorClass in namespace Automad\Engine\Processors
The content processor class.
$AbstractFeatureProcessor#ContentProcessorProperty in class AbstractFeatureProcessor
The content processor instance.
ConditionalProcessorClass in namespace Automad\Engine\Processors\Features
The conditional processor.
ContextProcessorClass in namespace Automad\Engine\Processors\Features
The context change processor.
PostProcessor::createExtensionAssetTags() — Method in class PostProcessor
Create the HTML tags for each file in the asset collection and prepend them to the closing tag.
$Toolbox#collectionProperty in class Toolbox
The full collection of pages.
ComposerClass in namespace Automad\System
The Composer class is a wrapper for setting up Composer and executing commands.
$Composer#composerVersionProperty in class Composer
The Composer version to be used.
$ThemeCollection#composerInstalledProperty in class ThemeCollection
An array of installed Composer packages.
ThemeCollection::collectThemes() — Method in class ThemeCollection
Collect installed themes recursively.
Mock::createAutomad() — Method in class Mock
Create a mock of the Automad object with a single page.
Mock::createCollection() — Method in class Mock
Create a collection of test pages.
ClearCacheClass in namespace Automad\UI\Commands
The clearcache command.
CreateUserClass in namespace Automad\UI\Commands
The createuser command.
ConsoleClass in namespace Automad\UI
The console class.
CacheControllerClass in namespace Automad\UI\Controllers
The Cache controller.
CacheController::clear() — Method in class CacheController
Clear the cache.
ImageController::copyResized() — Method in class ImageController
Copy an image resized based on $_POST.
$PackageManagerController#composerFileProperty in class PackageManagerController
The path to the composer.json file.
UserCollectionController::createUser() — Method in class UserCollectionController
Add user account based on $_POST.
UserController::changePassword() — Method in class UserController
Change the password of the currently logged in user based on $_POST.
Dashboard::classFileExists() — Method in class Dashboard
Test whether a file of a given class is readable.
ImageModel::copyResized() — Method in class ImageModel
Copy an image resized based on $_POST.
PageModel::contextUrlByPath() — Method in class PageModel
Return updated view URL based on $path.
$FieldResultsModel#contextProperty in class FieldResultsModel
A presenation string of all joined matches with wrapping context.
UserCollectionModel::createUser() — Method in class UserCollectionModel
Add user account.
UserCollectionModel::convertLegacyAccountsFile() — Method in class UserCollectionModel
Convert legacy accounts file content.
UserModel::changePassword() — Method in class UserModel
Change a user password
$Response#cliProperty in class Response
The output buffer used by CLI commands.
FileSystem::copyPageFiles() — Method in class FileSystem
Unlike self::movePageDir(), this method only copies all files within a page directory without (!) any subdirectories.
Keys::cleanUp() — Method in class Keys
Cleans up an array of keys. All reserved and duplicate keys get removed and the optional UI mask is applied.
Session::clearResetTokenHash() — Method in class Session
Clears the reset token hash

D

DelimiterClass in namespace Automad\Blocks
The delimiter block.
Config::defaults() — Method in class Config
Define default values for all constants that are not overriden.
DebugClass in namespace Automad\Core
The Debug class holds all methods to help debugging while development.
FileSystem::deleteFile() — Method in class FileSystem
Delete a file.
$LegacyData#dataProperty in class LegacyData
The actual data object that has to be tested and converted.
$Page#dataProperty in class Page
The $data array holds all the information stored as "key: value" in the text file and some other system generated information (:path, :level, :template .
$Pagelist#defaultsProperty in class Pagelist
The default set of options.
Parse::dataFile() — Method in class Parse
Loads and parses a text file.
RemoteFile::download() — Method in class RemoteFile
Downloads the remote file to the cache/downloads directory.
$Shared#dataProperty in class Shared
The shared data array.
Str::dateFormat() — Method in class Str
Change format of a given date, optionally according to locale settings.
Str::def() — Method in class Str
Set a default value for $str in case $str is empty.
$Runtime#dataProperty in class Runtime
The runtime data array.
Composer::downloadPhar() — Method in class Composer
Download the composer.phar file to a given directory.
$Theme#descriptionProperty in class Theme
The theme description.
DangerClass in namespace Automad\UI\Components\Alert
The danger alert component.
PageController::data() — Method in class PageController
Send form when there is no posted data in the request or save data if there is.
PageController::delete() — Method in class PageController
Delete page.
PageController::duplicate() — Method in class PageController
Duplicate a page.
SharedController::data() — Method in class SharedController
Send form when there is no posted data in the request or save data if there is.
DashboardClass in namespace Automad\UI
The dashboard class handles all user interactions using the dashboard.
FileCollectionModel::deleteFiles() — Method in class FileCollectionModel
Delete files.
PageModel::delete() — Method in class PageModel
Delete page.
PageModel::duplicate() — Method in class PageModel
Duplicate a page.
UserCollectionModel::delete() — Method in class UserCollectionModel
Delete one ore more user accounts.
$Response#debugProperty in class Response
The debug output buffer.
FileSystem::deleteMedia() — Method in class FileSystem
Deletes a file and its caption (if existing).

E

Debug::errorReporting() — Method in class Debug
Enable full error reporting, when debugging is enabled.
Page::extractTags() — Method in class Page
Extracts the tags string out of a given array and returns an array with these tags.
$Pagelist#excludeCurrentProperty in class Pagelist
Defines whether the pagelist excludes the current page or not.
$Pagelist#excludeHiddenProperty in class Pagelist
Defines whether the pagelist excludes hidden pages or not.
Selection::excludeCurrent() — Method in class Selection
Exclude the current page from the selection.
Selection::excludePage() — Method in class Selection
Remove a page from the selection.
Selection::excludeHidden() — Method in class Selection
Exclude all hidden pages from the selection.
Str::escape() — Method in class Str
Escapes a string to be used safely in a JSON string.
ExtensionClass in namespace Automad\Engine
The Extension class provides an interface for calling an extension from a template file.
PatternAssembly::expression() — Method in class PatternAssembly
Return the regex pattern for a single expression.
Pipe::extension() — Method in class Pipe
Call custom string function.
$Composer#extractionDirProperty in class Composer
Composer extraction directory within temporary directory.
Update::extractVersion() — Method in class Update
Extract version number form content of version.php.
$User#emailProperty in class User
The user's email.
EditorTextModulesClass in namespace Automad\UI\Components\Header
The block editor text modules as JS variable.
FileCollectionController::edit() — Method in class FileCollectionController
Remove selected files from the selection or simply return the collection of uploaded files for a context.
FileController::editInfo() — Method in class FileController
Edit file information (file name and caption).
HeadlessController::editTemplate() — Method in class HeadlessController
Save the updated template or render the editor in case no template was posted.
InPageController::edit() — Method in class InPageController
Handle AJAX request for editing a data variable in-page context.
UserCollectionController::edit() — Method in class UserCollectionController
Optionally remove posted accounts and return the accounts grid.
UserController::edit() — Method in class UserController
Edit user account info such as username and email.
FileModel::editInfo() — Method in class FileModel
Edit file information (file name and caption).
PageModel::extractPrefixFromPath() — Method in class PageModel
Extract the deepest directory's prefix from a given path.
PageModel::extractSlugFromPath() — Method in class PageModel
Extract the slug without the prefix from a given path.
UserCollectionModel::editCurrentUserInfo() — Method in class UserCollectionModel
Edit info of the currently logged in user.
$Response#errorProperty in class Response
The output buffer used for error notifications.
$Messenger#errorProperty in class Messenger
The last pushed error.

F

FilelistClass in namespace Automad\Blocks
The filelist block.
$Automad#FilelistProperty in class Automad
Automad's Filelist object
$Config#fileProperty in class Config
The configuration file.
FileSystemClass in namespace Automad\Core
The FileSystem class.
FileUtilsClass in namespace Automad\Core
A collection of file utilities.
FileUtils::fileDeclaration() — Method in class FileUtils
Parse a file declaration string where multiple glob patterns or URLs can be separated by a comma and return an array with the resolved/downloaded file paths.
FileUtils::fileIsImage() — Method in class FileUtils
Parse a filename to check whether a file is an image or not.
FilelistClass in namespace Automad\Core
The Filelist object represents a set of files based on a file pattern depending on the current context.
$Image#fileProperty in class Image
The filename of generated image.
$Image#fileFullPathProperty in class Image
The full file system path to the generated image.
$Pagelist#filterProperty in class Pagelist
The current filter.
Parse::fileDeclaration() — Method in class Parse
Please use FileUtils::fileDeclaration() instead.
Resolve::filePath() — Method in class Resolve
Resolve a file path or glob pattern according to its type (root relative or relative).
Selection::filterBreadcrumbs() — Method in class Selection
Collect all pages along a given URL.
Selection::filterByKeywords() — Method in class Selection
Filter $this->selection by multiple keywords (a search string), if $str is not empty.
Selection::filterByParentUrl() — Method in class Selection
Filter $this->selection by relative url of the parent page.
Selection::filterByTag() — Method in class Selection
Filter $this->selection by tag.
Selection::filterByTemplate() — Method in class Selection
Filter $this->selection by template. A regex can be used as filter string.
Selection::filterPrevAndNextToUrl() — Method in class Selection
Filter out the non-hidden neighbors (previous and next page) to the passed URL.
Selection::filterRelated() — Method in class Selection
Filter all pages having one or more tag in common with $Page. If there are not tags defined for the passed page, the selection will be an empty array. (no tags = no related pages)
Str::findFirstImage() — Method in class Str
Find the URL of the first image within rendered HTML markup.
Str::findFirstParagraph() — Method in class Str
Find the first paragraph in rendered HTML and return its inner HTML.
FeatureProviderClass in namespace Automad\Engine
The feature provider class.
FeatureProvider::findProcessorClasses() — Method in class FeatureProvider
Find all existing feature processors.
ForEachLoopProcessorClass in namespace Automad\Engine\Processors\Features
The foreach loop processor.
ForLoopProcessorClass in namespace Automad\Engine\Processors\Features
The for loop processor.
$TemplateProcessor#featureProcessorsProperty in class TemplateProcessor
An array of all existing feature processor instances.
Toolbox::filelist() — Method in class Toolbox
Configure the filelist to be used in foreach loops.
FileCollectionControllerClass in namespace Automad\UI\Controllers
The file collection controller.
FileControllerClass in namespace Automad\UI\Controllers
The file controller.
UIController::field() — Method in class UIController
Return the UI component for a variable field based on the name.
FileCollectionModelClass in namespace Automad\UI\Models
The file collection model.
FileModelClass in namespace Automad\UI\Models
The file model.
FieldResultsModelClass in namespace Automad\UI\Models\Search
A wrapper class for all results for a given data field.
FileKeysModelClass in namespace Automad\UI\Models\Search
A data class to store file => key associations.
FileResultsModelClass in namespace Automad\UI\Models\Search
A wrapper class for all results for a given data file.
$FileResultsModel#fieldResultsArrayProperty in class FileResultsModel
The array of FieldResultsModel.
FileSystemClass in namespace Automad\UI\Utils
The FileSystem class provides all methods related to file system operations.
FileSystem::fullPagePath() — Method in class FileSystem
Get the full file system path for the given path.
Keys::filterColorKeys() — Method in class Keys
Get color variable keys from an array of keys.
Keys::filterSettingKeys() — Method in class Keys
Get settings variable keys from an array of keys.
Keys::filterTextKeys() — Method in class Keys
Get text variable keys from an array of keys.

G

App::getAutomad() — Method in class App
Get Automad from cache or create new instance.
Automad::getCollection() — Method in class Automad
Return $collection array.
Automad::getFilelist() — Method in class Automad
Return Automad's instance of the Filelist class and create instance when accessed for the first time.
Automad::getPage() — Method in class Automad
If existing, return the page object for the passed relative URL.
Automad::getPagelist() — Method in class Automad
Return Automad's instance of the Pagelist class and create instance when accessed for the first time.
Automad::getRequestedPage() — Method in class Automad
Return the page object for the requested page.
Automad::getReservedUrls() — Method in class Automad
Get an array of reseverd URLs - all real directories within the base directory and the UI URL.
Cache::getSiteMTime() — Method in class Cache
Get an array of all subdirectories and all files under /pages, /shared, /themes and /config (and the version.php) and determine the latest mtime among all these items.
Cache::getDirectoriesRecursively() — Method in class Cache
Get all subdirectories of a given directory.
Cache::getPageCacheFilePath() — Method in class Cache
Determine the corresponding file in the cache for the requested page in consideration of a possible session data.
Context::get() — Method in class Context
Return $Page.
Debug::getLog() — Method in class Debug
Return the buffer array.
FileSystem::getExtension() — Method in class FileSystem
Return the extension for a given file.
FileSystem::getImageExtensionFromMimeType() — Method in class FileSystem
Get file extension for images based on mime types.
FileSystem::getTmpDir() — Method in class FileSystem
Return the path of the temp dir if it is writable by the webserver.
FileSystem::glob() — Method in class FileSystem
A wrapper for PHP's built-in glob function.
FileSystem::globGrep() — Method in class FileSystem
Find files by using the glob() method and filter the resulting array by a regex pattern.
Filelist::getFiles() — Method in class Filelist
Return the files array.
Image::getImageCacheFilePath() — Method in class Image
Determine the corresponding image file to a source file based on a md5 hash.
Page::get() — Method in class Page
Return requested data - from the page data array, from the shared data array or as generated system variable.
Page::getMtime() — Method in class Page
Get the modification time/date of the page.
Page::getTemplate() — Method in class Page
Return the template of the page.
Pagelist::getDefaults() — Method in class Pagelist
Return the default options array.
Pagelist::getPages() — Method in class Pagelist
The final set of Page objects - filtered.
Pagelist::getPaginationCount() — Method in class Pagelist
Calculate the number of pages of the pagination.
Pagelist::getTags() — Method in class Pagelist
Return all tags from all pages in $relevant as array.
Pagelist::getRelevant() — Method in class Pagelist
Collect all pages matching $type (& optional $context), $template & $search (optional).
RemoteFile::getLocalCopy() — Method in class RemoteFile
Returns the local copy's path.
Router::get() — Method in class Router
Test a given URL against the registered route patterns and return a matching function.
Selection::getSelection() — Method in class Selection
Return the array with the selected (filtered and sorted) pages.
SessionData::get() — Method in class SessionData
Get the session data array or just one value in case $key is defined.
Shared::get() — Method in class Shared
Return requested value.
Sitemap::generate() — Method in class Sitemap
Generate the XML for the sitemap and write sitemap.xml.
AssetCollection::get() — Method in class AssetCollection
Return the asset array.
SnippetCollection::get() — Method in class SnippetCollection
Get a snippet definition body.
SnippetCollection::getCollection() — Method in class SnippetCollection
Get the full collection of snippet definitions.
Extension::getAssets() — Method in class Extension
Return an array of assets of the extension.
Extension::getOutput() — Method in class Extension
Return the output of the extension.
FeatureProvider::getProcessorClasses() — Method in class FeatureProvider
Return the array of feature processor class names.
Headless::getTemplate() — Method in class Headless
Checks whether a custom headless template exists and returns its path.
ContentProcessor::getValue() — Method in class ContentProcessor
Get the value of a given variable key depending on the current context - either from the page data, the system variables or from the $_GET array.
Runtime::get() — Method in class Runtime
Return the requested runtime variable.
Composer::getInstallDir() — Method in class Composer
Read the Composer install directory from cache to reuse the installation in case Composer was already used before. In case Composer hasn't been used before, a new path will be generated and save to the cache.
Packagist::getPackages() — Method in class Packagist
Get a list op packages from Packagist filtered by type and tag.
ThemeCollection::getThemeByKey() — Method in class ThemeCollection
Get the theme object by the key in the themelist array corresponding to the AM_KEY_THEME variable.
ThemeCollection::getThemes() — Method in class ThemeCollection
Return the Theme objects array.
ThemeCollection::getComposerInstalled() — Method in class ThemeCollection
Get installed Composer packages.
Update::getVersion() — Method in class Update
Download version file and extract version number.
Update::getArchive() — Method in class Update
Download zip-archive to be installed.
Theme::getMask() — Method in class Theme
Get the UI mask (page or shared) for hiding variables in the dashboard.
Theme::getTooltip() — Method in class Theme
Return the tooltip for the requested variable name (key in the data array).
User::getPasswordHash() — Method in class User
Get a hashed version of a user password.
Console::getCommands() — Method in class Console
Get the list of available commands.
PackageManagerController::getOutdatedPackages() — Method in class PackageManagerController
Get a list of outdated packages.
PackageManagerController::getPackages() — Method in class PackageManagerController
Get a list of theme packages available on Packagist where the installed ones are at the beginning.
PackageManagerController::getInstalled() — Method in class PackageManagerController
Get the array of installed packages.
PageController::getTemplateNameFromArray() — Method in class PageController
Get the theme/template file from posted data or return a default template name.
StatusController::get() — Method in class StatusController
Get a config item status.
Dashboard::get() — Method in class Dashboard
Get the rendered output.
PageModel::getPageFilePath() — Method in class PageModel
Return the full file system path of a page's data file.
UserCollectionModel::generatePHP() — Method in class UserCollectionModel
Generate the PHP code for the accounts file. Basically the code returns the unserialized serialized array with all users.
UserCollectionModel::getCollection() — Method in class UserCollectionModel
Return the user collection array.
UserCollectionModel::getUser() — Method in class UserCollectionModel
Return a user by name or email address.
UserCollectionModel::getUserId() — Method in class UserCollectionModel
Return a user id by name or email address.
Response::getBuffer() — Method in class Response
Get the buffer property.
Response::getCli() — Method in class Response
Get the cli property.
Response::getError() — Method in class Response
Get the error property.
FileSystem::getPackagesDirectoryItems() — Method in class FileSystem
Get all items in the packages directory, optionally filtered by a regex string.
FileSystem::getPathByPostUrl() — Method in class FileSystem
Return the file system path for the directory of a page based on $_POST['url'].
Messenger::getError() — Method in class Messenger
Return the stored error message.
Session::getResetTokenHash() — Method in class Session
Return the reset token hash for a given user.
Session::getUsername() — Method in class Session
Return the currently logged in user.
Text::get() — Method in class Text
Return the requested text module.
Text::getEditorModules() — Method in class Text
Return array only including editor text modlues.
Text::getObject() — Method in class Text
Return the modules as object to be used in heredoc strings.
UICache::get() — Method in class UICache
Restore Automad object including private pages from cache or create a new version and write it to the cache if outdated.
URLHashes::get() — Method in class URLHashes
Get a std class object of the hashes.

H

HeaderClass in namespace Automad\Blocks
The header block.
$Image#heightProperty in class Image
The height of the generated image.
HeadlessClass in namespace Automad\Engine
The Headless class provides helpers for the headless mode.
$ContentProcessor#headlessProperty in class ContentProcessor
A boolean variable that contains the headless state
$PostProcessor#headlessProperty in class PostProcessor
A boolean variable that contains the headless state
$View#headlessProperty in class View
A boolean variable that contains the headless state
Update::higherPHPVersionRequired() — Method in class Update
Check if the server's PHP version matches the minimum requirements in the remote composer.json file.
User::hash() — Method in class User
Create hash from password to store in accounts.txt.
AbstractCommand::help() — Method in class AbstractCommand
Get the command help.
ClearCache::help() — Method in class ClearCache
Get the command help.
CreateUser::help() — Method in class CreateUser
Get the command help.
Purge::help() — Method in class Purge
Get the command help.
Update::help() — Method in class Update
Get the command help.
Console::help() — Method in class Console
Show the help for all available commands.
HeadlessControllerClass in namespace Automad\UI\Controllers
The headless controller.
$Response#htmlProperty in class Response
The main rendered output of a view or component.
$URLHashes#hashesProperty in class URLHashes
The URL hashes used in the UI.

I

Autoload::init() — Method in class Autoload
Blocks::injectAssets() — Method in class Blocks
Inject block assets into the header of a page.
FileSystem::isAllowedFileType() — Method in class FileSystem
Tests if a string is a file name with an allowed file extension.
ImageClass in namespace Automad\Core
The Image object represents a resized (and cropped) copy of a given image.
Page::isCurrent() — Method in class Page
Check if page is the current page.
Page::isInCurrentPath() — Method in class Page
Check if the page URL is a part the current page's URL.
PatternAssembly::inPageEditButton() — Method in class PatternAssembly
Return regex to match any temporary in-page edit button.
$ContentProcessor#InPageProperty in class ContentProcessor
The InPage instance.
AbstractFeatureProcessor::initTemplateProcessor() — Method in class AbstractFeatureProcessor
Create a new instance of the template processor.
IncludeProcessorClass in namespace Automad\Engine\Processors\Features
The include processor.
InvocationProcessorClass in namespace Automad\Engine\Processors\Features
The snippet, Toolbox method or extension method invocation processor.
$PostProcessor#InPageProperty in class PostProcessor
The InPage instance.
TemplateProcessor::initFeatureProcessors() — Method in class TemplateProcessor
Create instances of all existing feature processors and bundle them in an array.
Toolbox::img() — Method in class Toolbox
Place an image.
$Composer#installDirCacheFileProperty in class Composer
A chached file including the temporary Composer install directory.
Update::items() — Method in class Update
Get items to be updated from config.
Jumpbar::inPage() — Method in class Jumpbar
Generate autocomplete items for the in-page edit mode.
FileController::import() — Method in class FileController
Import file from URL.
ImageControllerClass in namespace Automad\UI\Controllers
The Image controller.
InPageControllerClass in namespace Automad\UI\Controllers
The inPage controller.
PackageManagerController::install() — Method in class PackageManagerController
Install a package.
UserCollectionController::install() — Method in class UserCollectionController
Install the first user account.
UserCollectionController::inviteUser() — Method in class UserCollectionController
Invite a new user by email.
FileModel::import() — Method in class FileModel
Import file from URL.
ImageModelClass in namespace Automad\UI\Models
The Image controller.
SearchModel::isValidBlockProperty() — Method in class SearchModel
Check whether a property name represents a valid block property.
UserCollectionModel::invalidEmailError() — Method in class UserCollectionModel
The invalid email error message.
UserCollectionModel::invalidUsernameError() — Method in class UserCollectionModel
The invalid username error message.
Keys::inCurrentTemplate() — Method in class Keys
Find all variable keys in the currently used template and all included snippets (and ignore those keys in $this->reserved).
Keys::inTemplate() — Method in class Keys
Find all variable keys in a template and all included snippets (and ignore those keys in $this->reserved).
Keys::inTheme() — Method in class Keys
Find all variable keys in templates of a given theme.

J

Parse::jsonOptions() — Method in class Parse
Parse a (dirty) JSON string and return an associative, filtered array
JumpbarClass in namespace Automad\UI\Components\Autocomplete
The autocomplete JSON data for jump bar component.
UIController::jump() — Method in class UIController
Redirect to a given target URL.
Response::json() — Method in class Response
Return a json encoded and filterd array of properties.

K

PatternAssembly::keyValue() — Method in class PatternAssembly
Return a regex pattern to match key/value pairs in an invalid JSON string without valid quoting/escaping.
$FieldResultsModel#keyProperty in class FieldResultsModel
The field name.
$FileKeysModel#keysProperty in class FileKeysModel
The keys array.
KeysClass in namespace Automad\UI\Utils
The Keys class provides all methods to search all kind of content variables (keys of the data array) used in templates.

L

ListsClass in namespace Automad\Blocks
The list block.
Automad::loadTemplate() — Method in class Automad
Load and buffer a template file and return its content as string. The Automad object gets passed as parameter to be available for all plain PHP within the included file.
$Config#legacyProperty in class Config
The legacy .json file.
Debug::log() — Method in class Debug
Log any kind of variable and append it to the $buffer array.
LegacyDataClass in namespace Automad\Core
The LegacyData class handles the conversion of legacy block data.
$Pagelist#limitProperty in class Pagelist
Defines the maximum number of pages in the array returned by getPages().
$RemoteFile#localCopyProperty in class RemoteFile
The local copy in the downloads directory of the external file.
$PatternAssembly#logicalOperatorProperty in class PatternAssembly
Logical operand "and" or "or".
Update::log() — Method in class Update
Log events to the update log file.
$Theme#licenseProperty in class Theme
The theme license.
LinkClass in namespace Automad\UI\Components\Autocomplete
The autocomplete JSON data for links component.
LoadingClass in namespace Automad\UI\Components
The loading spinner component.
LogoClass in namespace Automad\UI\Components
The Logo class handles the loading of the Automad logo and the headless indicator.
HeadlessController::loadTemplate() — Method in class HeadlessController
Get the content of the template in use.
SessionController::login() — Method in class SessionController
Verify login information based on $_POST.
SessionController::logout() — Method in class SessionController
Log out user.
LinksModelClass in namespace Automad\UI\Models
The links model.
UserCollectionModel::load() — Method in class UserCollectionModel
Get the accounts array by including the accounts PHP file.
FileSystem::listDirectoryRecursively() — Method in class FileSystem
Recursively list all items in a directory.
Session::login() — Method in class Session
Verify login information based on $_POST.
Session::logout() — Method in class Session
Log out user.

M

Automad::makeUrl() — Method in class Automad
Builds an URL out of the parent URL and the actual file system folder name.
Debug::memory() — Method in class Debug
Provide info about memory usage.
FileSystem::makeDir() — Method in class FileSystem
Create directory if not existing.
$Pagelist#matchProperty in class Pagelist
Defines a JSON string to be used as paramter for the $Selection->match() method.
Selection::match() — Method in class Selection
While iterating a set of variable/regex combinations in $options, all pages where a given variable is not matching its assigned regex are removed from the selection.
Str::markdown() — Method in class Str
Parse a markdown string. Optionally skip parsing in case $str is a single line string.
Str::match() — Method in class Str
Perform a regex match.
AssetCollection::merge() — Method in class AssetCollection
Multidimensionally merge assets.
Pipe::math() — Method in class Pipe
Simple math operations.
MailClass in namespace Automad\System
The mail class.
MockClass in namespace Automad\Test
The test mock class.
$Theme#masksProperty in class Theme
A multidimensional mask array.
PageController::move() — Method in class PageController
Move a page.
PageModel::moveDirAndUpdateLinks() — Method in class PageModel
Move a page directory and update all related links.
SearchModel::mergeFieldResults() — Method in class SearchModel
Merge an array of FieldResultsModel into a single results.
$FieldResultsModel#matchesProperty in class FieldResultsModel
An array with all found matches in the field value.
FileSystem::movePageDir() — Method in class FileSystem
Move a directory to a new location.
MessengerClass in namespace Automad\UI\Utils
The Messenger object allows for pushing error messages to the calling method in order to separate return values from error details.
$Text#modulesProperty in class Text
Array of UI text modules.

N

FileSystem::normalizeSlashes() — Method in class FileSystem
Replace all backslashes in a given path with forward slashes.
$PatternAssembly#numberProperty in class PatternAssembly
Number (integer and float).
Toolbox::nav() — Method in class Toolbox
Generate a list for the navigation below a given URL.
Toolbox::navChildren() — Method in class Toolbox
Generate a list for the navigation below the current page.
Toolbox::navSiblings() — Method in class Toolbox
Generate a list for the navigation below the current page's parent.
Toolbox::navTop() — Method in class Toolbox
Generate a list for the navigation at the top level including the home page (level 0 & 1).
Toolbox::navTree() — Method in class Toolbox
Generate full navigation tree.
Toolbox::newPagelist() — Method in class Toolbox
Alias for calling the pagelist() method with the default options merged with the specified ones to override all previous configurations.
Composer::newInstallDir() — Method in class Composer
Generate a fresh installation directory for Composer.
$Theme#nameProperty in class Theme
The theme name.
$User#nameProperty in class User
The username.
AbstractCommand::name() — Method in class AbstractCommand
Get the command name.
ClearCache::name() — Method in class ClearCache
Get the command name.
CreateUser::name() — Method in class CreateUser
Get the command name.
Purge::name() — Method in class Purge
Get the command name.
Update::name() — Method in class Update
Get the command name.

O

$Cache#objectCacheFileProperty in class Cache
The filename for the object cache.
Config::overrides() — Method in class Config
Define constants based on the configuration array.
$Filelist#optionsProperty in class Filelist
The options array.
$Image#originalHeightProperty in class Image
The height of the source image.
$Image#originalWidthProperty in class Image
The width of the source image.
$Image#originalFileProperty in class Image
The filename of the source image
$Pagelist#offsetProperty in class Pagelist
Defines the offset within the array of pages returned by getPages().
$Extension#outputProperty in class Extension
The retured output of the extension.
$PatternAssembly#outerStatementMarkerProperty in class PatternAssembly
The outer statement marker helps to distinguish all outer wrapping statements from the inner statements.
PatternAssembly::operand() — Method in class PatternAssembly
Return the regex to match one operand of an expression.
PostProcessor::obfuscateEmails() — Method in class PostProcessor
Obfuscate all stand-alone eMail addresses matched in $str.
$Dashboard#outputProperty in class Dashboard
The dashboard output.

P

PagelistClass in namespace Automad\Blocks
The pagelist block.
ParagraphClass in namespace Automad\Blocks
The paragraph block.
$Automad#PagelistProperty in class Automad
Automad's Pagelist object.
Automad::pageNotFound() — Method in class Automad
Create a temporary page for a missing page and send a 404 header.
Blocks::prepareData() — Method in class Blocks
Prepare block data
$Cache#pageCacheFileProperty in class Cache
The determined matching file of the cached version of the currently visited page.
$Cache#pageCachingIsEnabledProperty in class Cache
In contrast to the AM_CACHE_ENABLED constant, this variable is only for storing the status of the page cache, independent from the Automad object cache.
Cache::pageCacheIsApproved() — Method in class Cache
Verify if the cached version of the visited page is existing and still up to date.
$Context#PageProperty in class Context
The context Page.
PageClass in namespace Automad\Core
The Page class holds all properties and methods of a single page.
PagelistClass in namespace Automad\Core
A Pagelist object represents a set of Page objects (matching certain criterias).
$Pagelist#pageProperty in class Pagelist
The current page of the pagination.
ParseClass in namespace Automad\Core
The Parse class holds all parsing methods.
Request::page() — Method in class Request
Return the URL of the currently requested page.
Request::post() — Method in class Request
Return value by key in the $_POST array or any empty string, if that key doesn't exist.
$FeatureProvider#processorClassesProperty in class FeatureProvider
An array with names of all existing feature processor classes.
PatternAssemblyClass in namespace Automad\Engine
The PatternAssembly class contains all methods to assemble regular expressions patterns.
PatternAssembly::pipe() — Method in class PatternAssembly
Return the regex for a piped string function or math operation of content variables.
PipeClass in namespace Automad\Engine
The Pipe class handles the chain of processes to manipulate variable values.
$Pipe#phpFunctionsProperty in class Pipe
Whitelist of standard PHP functions.
Pipe::process() — Method in class Pipe
Processes an array of functions applied to a given value.
ContentProcessor::processFileSnippet() — Method in class ContentProcessor
Process a file related snippet like `<@ foreach "*.jpg" { options } @> .
ContentProcessor::processVariables() — Method in class ContentProcessor
Process content variables and optional string functions. Like {[ var | function1 ( parameters ) | function2 | .
AbstractFeatureProcessor::process() — Method in class AbstractFeatureProcessor
The actual processor that is used to process a template substring that matches the pattern returned by the syntaxPattern() method.
ConditionalProcessor::process() — Method in class ConditionalProcessor
Process if and `if .
ContextProcessor::process() — Method in class ContextProcessor
Process with and `with .
ForEachLoopProcessor::process() — Method in class ForEachLoopProcessor
Process foreach and `foreach .
ForLoopProcessor::process() — Method in class ForLoopProcessor
Process for loops.
IncludeProcessor::process() — Method in class IncludeProcessor
Process include statements.
InvocationProcessor::process() — Method in class InvocationProcessor
Process invocations of Toolbox methods, snippets or extensions.
SnippetDefinitionProcessor::process() — Method in class SnippetDefinitionProcessor
Process snippet definitions and add them to the snippet collection.
PostProcessorClass in namespace Automad\Engine\Processors
The post-processor class.
PostProcessor::process() — Method in class PostProcessor
Run all required post-process steps.
PreProcessorClass in namespace Automad\Engine\Processors
The pre-processor class.
PreProcessor::prepareWrappingStatements() — Method in class PreProcessor
Preprocess recursive statements to identify the top-level (outer) statements within a parsed string.
TemplateProcessor::process() — Method in class TemplateProcessor
The main template render process basically applies all feature processors to the rendered template.
Toolbox::pagelist() — Method in class Toolbox
Change of configuration for Automad's Pagelist object.
$Composer#pharUrlProperty in class Composer
The download URL for the composer.phar file.
PackagistClass in namespace Automad\System
The Packagist class handles all requests to the Packagist API.
Update::permissionsGranted() — Method in class Update
Test if permissions for all items to be updated are granted.
Update::preloadClasses() — Method in class Update
Preload required classes before removing old installation.
$Theme#pathProperty in class Theme
The theme path.
$User#passwordHashProperty in class User
The encrypted password.
PurgeClass in namespace Automad\UI\Commands
The purge command.
Jumpbar::packages() — Method in class Jumpbar
Generate autocomplete items for packages.
Jumpbar::pages() — Method in class Jumpbar
Generate autocomplete items for pages.
CacheController::purge() — Method in class CacheController
Purge the cache directory.
PackageManagerControllerClass in namespace Automad\UI\Controllers
The PackageManager class provides all methods required by the dashboard to manage packages.
PageControllerClass in namespace Automad\UI\Controllers
The Page controller.
PageModelClass in namespace Automad\UI\Models
The Page model.
$FileKeysModel#pathProperty in class FileKeysModel
The file path.
$FileResultsModel#pathProperty in class FileResultsModel
The file path.
$FileSystem#packageDirectoryItemsProperty in class FileSystem
The cached array of items in the packages directory.
FileSystem::purgeCache() — Method in class FileSystem
Move all items in /cache to the PHP temp directory.
PrefixClass in namespace Automad\UI\Utils
The Prefix class provides helper to use standard UIkit classes without needing to prefix them manually to avoid conflicts (in page editing).
$Prefix#prefixProperty in class Prefix
The custom prefix to replace 'uk-'.
Text::parseModules() — Method in class Text
Parse the text modules file and store all modules in Text::$modules.

Q

Request::query() — Method in class Request
Return a sanitized value of a query string parameter or any empty string, if that parameter doesn't exist.
Toolbox::queryStringMerge() — Method in class Toolbox
Merge passed key-value pairs ($options) with current query string.

R

$App#requiredVersionProperty in class App
Required PHP version.
App::render() — Method in class App
Get the generated output for the current request.
App::runPermissionCheck() — Method in class App
Run a basic permission check on the cache directory.
App::runVersionCheck() — Method in class App
Run a basic PHP version check.
AbstractBlock::render() — Method in class AbstractBlock
Render a paragraph block.
Code::render() — Method in class Code
Render a code block.
Delimiter::render() — Method in class Delimiter
Render a delimiter block.
Filelist::render() — Method in class Filelist
Render a filelist block.
Header::render() — Method in class Header
Render a header block.
Lists::render() — Method in class Lists
Render a list block.
Lists::renderItems() — Method in class Lists
Render list items.
Pagelist::render() — Method in class Pagelist
Render a pagelist block.
Paragraph::render() — Method in class Paragraph
Render a paragraph block.
RawClass in namespace Automad\Blocks
The raw HTML and markdown block.
Raw::render() — Method in class Raw
Render a raw block.
Snippet::render() — Method in class Snippet
Render a snippet block.
Table::render() — Method in class Table
Render a table block.
Toc::render() — Method in class Toc
Render a toc block.
$Automad#reservedUrlsProperty in class Automad
An array of existing directories within the base directory (/automad, /config, /pages etc.)
Blocks::render() — Method in class Blocks
Render blocks created by the EditorJS block editor.
Cache::readAutomadObjectFromCache() — Method in class Cache
Read (unserialize) the Automad object from $this->objectCacheFile and update the context to the requested page.
Cache::readPageFromCache() — Method in class Cache
Read the rendered page from the cached version.
Cache::readSiteMTime() — Method in class Cache
Read the site's modification time from file.
Config::read() — Method in class Config
Read configuration overrides as JSON string form PHP or JSON file and decode the returned string. Note that now the configuration is stored in PHP files instead of JSON files to make it less easy to access from outside.
$Image#requestedHeightProperty in class Image
The desired height of the new image. (May not be the resulting width, depending on cropping or original image size)
$Image#requestedWidthProperty in class Image
The disired width of the new image. (May not be the resulting width, depending on cropping or original image size)
RemoteFileClass in namespace Automad\Core
The remote file class.
RequestClass in namespace Automad\Core
The Request class.
ResolveClass in namespace Automad\Core
The Resolve class holds all methods to modulate URLs and file paths.
Resolve::relativeUrlToBase() — Method in class Resolve
Resolve relative URLs (starting with a character or .) to be absolute URLs, using the base directory (where Automad is installed) as root.
RouterClass in namespace Automad\Core
The Router class handles the registration and evaluation of routes.
$Router#routesProperty in class Router
The routes array.
Router::register() — Method in class Router
Register a new route.
Str::replace() — Method in class Str
Search and replace by regex.
$ContentProcessor#RuntimeProperty in class ContentProcessor
The Runtime instance.
$AbstractFeatureProcessor#RuntimeProperty in class AbstractFeatureProcessor
The Runtime instance.
PostProcessor::resizeImages() — Method in class PostProcessor
Resize any image in the output in case it has a specified size as query string like for example "/shared/image.jpg?200x200".
$TemplateProcessor#RuntimeProperty in class TemplateProcessor
The Runtime instance.
URLProcessor::resolveUrls() — Method in class URLProcessor
Find and resolve URLs using the specified resolving method and parameters.
RuntimeClass in namespace Automad\Engine
The Runtime class handles all variables generated during runtime.
Toolbox::redirect() — Method in class Toolbox
Redirect page.
View::render() — Method in class View
Render a page.
$Composer#reservedShutdownMemoryProperty in class Composer
A variable to reserve memory for running a shutdown function when Composer reaches the allowd memory limit.
Composer::run() — Method in class Composer
Run a given Composer command.
Packagist::request() — Method in class Packagist
Make a request to the Packagist API.
Update::run() — Method in class Update
Run the actual update.
$Theme#readmeProperty in class Theme
The theme readme path.
AbstractCommand::run() — Method in class AbstractCommand
The actual command action.
ClearCache::run() — Method in class ClearCache
The actual command action.
CreateUser::run() — Method in class CreateUser
The actual command action.
Purge::run() — Method in class Purge
The actual command action.
Update::run() — Method in class Update
The actual command action.
Danger::render() — Method in class Danger
Render a danger alert box.
Success::render() — Method in class Success
Render a success alert box.
Jumpbar::render() — Method in class Jumpbar
Return a JSON formatted string to be used as autocomplete infomation in a jump field.
Link::render() — Method in class Link
Return a JSON formatted string to be used as autocomplete infomation in a link field.
BlockSnippetArrays::render() — Method in class BlockSnippetArrays
Return a script tag to define the block snippet arrays for the block editor.
EditorTextModules::render() — Method in class EditorTextModules
Return a script tag to define the translated text modules for the block editor.
SearchResults::render() — Method in class SearchResults
Render the search results layout.
Loading::render() — Method in class Loading
Create loading icon.
Logo::render() — Method in class Logo
Return the Automad logo and if the headless mode is enabled also the headless indicator.
Breadcrumbs::render() — Method in class Breadcrumbs
Create a breadcrumb navigation based on $_GET.
SiteTree::render() — Method in class SiteTree
Create recursive site tree for editing a page.
Span::render() — Method in class Span
Create a span for an AJAX status request.
Console::runCommand() — Method in class Console
Run a command based on the $argv array.
HeadlessController::resetTemplate() — Method in class HeadlessController
Reset the headless template by deleting the custom template file.
PackageManagerController::remove() — Method in class PackageManagerController
Remove a package.
UserController::resetPassword() — Method in class UserController
Reset a user password by email.
Dashboard::registerControllerErrorHandler() — Method in class Dashboard
Register a error handler that sends a 500 response code in case of a fatal error created by a controller.
ReplacementModelClass in namespace Automad\UI\Models
The Replacement model.
$ReplacementModel#regexFlagsProperty in class ReplacementModel
The search regex flags.
$ReplacementModel#replaceValueProperty in class ReplacementModel
The replace value.
ReplacementModel::replaceInFiles() — Method in class ReplacementModel
Replace matches with a given string in a given list of files.
ReplacementModel::replaceInBlocksRecursively() — Method in class ReplacementModel
Replace matches in block data recursively.
ReplacementModel::replaceInData() — Method in class ReplacementModel
Replace matches in data for a given list of keys.
ReplacementModel::replaceInValueRecursively() — Method in class ReplacementModel
Replace searched string in a value that is either a string or an multidimensional array of strings.
$SearchModel#regexFlagsProperty in class SearchModel
The search regex flags.
UserModel::resetPassword() — Method in class UserModel
Handle password resetting.
ResponseClass in namespace Automad\UI
The Response class.
$Response#redirectProperty in class Response
The output buffer used to store a redirect URL.
$Response#reloadProperty in class Response
The output buffer used to store the reload state.
FileSystem::renameMedia() — Method in class FileSystem
Renames a file and its caption (if existing).
$Keys#reservedProperty in class Keys
Array with reserved variable keys.
UICache::rebuild() — Method in class UICache
Force a rebuild of the UI cache.

S

App::startSession() — Method in class App
Initialize a PHP session.
SnippetClass in namespace Automad\Blocks
The snippet block.
$Snippet#snippetIsRenderingProperty in class Snippet
This variable tracks whether a snippet is called by another snippet to prevent inifinte recursive loops.
$Automad#SharedProperty in class Automad
Automad's Shared object.
$Cache#siteMTimeProperty in class Cache
The latest modification time of the whole website (any file or directory).
Config::set() — Method in class Config
Define constant, if not defined already.
Context::set() — Method in class Context
Set the context.
$Page#SharedProperty in class Page
The Shared data object.
$Pagelist#searchProperty in class Pagelist
The search string to filter pages.
$Pagelist#sortProperty in class Pagelist
The sort options string.
SelectionClass in namespace Automad\Core
The Selection class holds all methods to filter and sort the collection of pages and return them as a new selection.
$Selection#selectionProperty in class Selection
Initially holds the whole collection.
Selection::sortPages() — Method in class Selection
Sorts $this->selection based on a sorting options string.
SessionDataClass in namespace Automad\Core
The SessionData class handles setting and getting items of $_SESSION['data'].
SessionData::set() — Method in class SessionData
Set a key/value pair in the session data array.
SharedClass in namespace Automad\Core
The Shared class represents a collection of all shared site-wide data.
Shared::set() — Method in class Shared
Set key/value pair in data.
SitemapClass in namespace Automad\Core
The Sitemap class handles the generating process for a site's sitemap.xml.
StrClass in namespace Automad\Core
The Str class holds all string methods.
Str::sanitize() — Method in class Str
Cleans up a string to be used as URL, directory or file name.
Str::shorten() — Method in class Str
Shortens a string keeping full words. Note that this method also first strips all tags from the given string.
Str::slug() — Method in class Str
Creates a slug for save diretory names, ids or similar from a given string.
Str::stripEnd() — Method in class Str
Strip substring from end of string.
Str::stripStart() — Method in class Str
Strip substring from start of string.
Str::stripTags() — Method in class Str
Removes all HTML and Markdown (!) tags.
SnippetCollectionClass in namespace Automad\Engine\Collections
The snippet collection.
$SnippetCollection#snippetsProperty in class SnippetCollection
An array for collection snippet definitions.
Pipe::stringFunction() — Method in class Pipe
Apply string function to $value.
AbstractFeatureProcessor::syntaxPattern() — Method in class AbstractFeatureProcessor
The actual pattern that is used to trigger the processor.
ConditionalProcessor::syntaxPattern() — Method in class ConditionalProcessor
The pattern that is used to match conditionals in a template string.
ContextProcessor::syntaxPattern() — Method in class ContextProcessor
The pattern that is used to match context change statements in a template string.
ForEachLoopProcessor::syntaxPattern() — Method in class ForEachLoopProcessor
The pattern that is used to match foreach loops.
ForLoopProcessor::syntaxPattern() — Method in class ForLoopProcessor
The pattern that is used to match for loops.
IncludeProcessor::syntaxPattern() — Method in class IncludeProcessor
The pattern that is used to match include statements.
InvocationProcessor::syntaxPattern() — Method in class InvocationProcessor
The pattern that is used to match invocations.
SnippetDefinitionProcessorClass in namespace Automad\Engine\Processors\Features
The snippet definition processor.
SnippetDefinitionProcessor::syntaxPattern() — Method in class SnippetDefinitionProcessor
The pattern that is used to match snippet definitions.
PreProcessor::stripWhitespace() — Method in class PreProcessor
Strip whitespace before or after delimiters when using <@~ or ~@>.
Runtime::set() — Method in class Runtime
Set a runtime variable.
Runtime::shelve() — Method in class Runtime
Get the $data array to be shelved and restored at a later point.
Toolbox::set() — Method in class Toolbox
Set shared or session data variables by passing an array of key/value pairs.
Composer::setUp() — Method in class Composer
Set up Composer by downloading and extracting the composer.phar to a temporary directory outside the document root, defining some environment variables, registering a shutdown function and including the autoloader.
Composer::shutdownOnError() — Method in class Composer
A shutdown function to handle memory limit erros.
$Mail#sentProperty in class Mail
Save status to avoid a second trigger for example in pagelists or teaser snippets.
Mail::send() — Method in class Mail
Send mail.
ServerClass in namespace Automad\System
The Server util class contains helper functions for server information.
Update::supported() — Method in class Update
Test if the server supports all required functions.
User::setPasswordHash() — Method in class User
Store a hashed version of a given clear text password.
SuccessClass in namespace Automad\UI\Components\Alert
The success alert component.
Jumpbar::search() — Method in class Jumpbar
Generate autocomplete items for search.
Jumpbar::settings() — Method in class Jumpbar
Generate autocomplete items for settings.
Jumpbar::shared() — Method in class Jumpbar
Generate autocomplete items for shared.
SearchResultsClass in namespace Automad\UI\Components\Layout
The search layout.
SiteTreeClass in namespace Automad\UI\Components\Nav
The site tree component.
SpanClass in namespace Automad\UI\Components\Status
The status span component.
ImageController::select() — Method in class ImageController
Select an image.
PageController::save() — Method in class PageController
Save a page.
SearchControllerClass in namespace Automad\UI\Controllers
The Search controller.
SearchController::searchAndReplace() — Method in class SearchController
Perform a search and replace.
SessionControllerClass in namespace Automad\UI\Controllers
The Session controller class provides all methods related to a user session.
SharedControllerClass in namespace Automad\UI\Controllers
The Shared data controller.
SharedController::save() — Method in class SharedController
Save shared data.
StatusControllerClass in namespace Automad\UI\Controllers
The status controller.
SystemControllerClass in namespace Automad\UI\Controllers
The system controller.
ImageModel::select() — Method in class ImageModel
Select an image.
PageModel::save() — Method in class PageModel
Save page data.
$ReplacementModel#searchValueProperty in class ReplacementModel
The search value.
SearchModelClass in namespace Automad\UI\Models
The Search model.
$SearchModel#searchValueProperty in class SearchModel
The search value.
SearchModel::searchPerFile() — Method in class SearchModel
Perform a search in all data arrays and return an array with FileResultsModel.
SearchModel::searchArrayRecursively() — Method in class SearchModel
Search an array of values recursively.
SearchModel::searchBlocksRecursively() — Method in class SearchModel
Perform a search in a block field recursively and return a FieldResultsModel results for a given search value.
SearchModel::searchData() — Method in class SearchModel
Perform a search in a single data array and return an array of FieldResultsModel.
SearchModel::searchTextField() — Method in class SearchModel
Perform a search in a single data field and return a FieldResultsModel results for a given search value.
UserCollectionModel::save() — Method in class UserCollectionModel
Save the accounts array as PHP to AM_FILE_ACCOUNTS.
UserCollectionModel::sendInvitation() — Method in class UserCollectionModel
Send invitation email.
UserModel::sendPasswordResetToken() — Method in class UserModel
Send password reset token and store it in session.
$Response#statusProperty in class Response
The status output buffer.
$Response#successProperty in class Response
The output buffer used for success notifications.
Response::setAutocomplete() — Method in class Response
Set the autocomplete property.
Response::setBuffer() — Method in class Response
Set the buffer property.
Response::setCli() — Method in class Response
Set the cli property.
Response::setDebug() — Method in class Response
Set the debug property.
Response::setError() — Method in class Response
Set the error property.
Response::setHtml() — Method in class Response
Set the html property.
Response::setRedirect() — Method in class Response
Set the redirect property.
Response::setReload() — Method in class Response
Set the reload property.
Response::setStatus() — Method in class Response
Set the status property.
Response::setSuccess() — Method in class Response
Set the success property.
Response::setTrigger() — Method in class Response
Set the trigger property.
Messenger::setError() — Method in class Messenger
Set the last error.
SessionClass in namespace Automad\UI\Utils
The Session model class provides all methods related to a user session.
Session::setResetTokenHash() — Method in class Session
Set the reset token hash for a given user.

T

$Lists#tagProperty in class Lists
The list type tag
TableClass in namespace Automad\Blocks
The table block.
TocClass in namespace Automad\Blocks
The table of contents block.
$Debug#timeProperty in class Debug
Timestamp when script started.
Debug::timerStart() — Method in class Debug
Start the timer on the first call to calculate the execution time when consoleLog() gets called.
Debug::timerStop() — Method in class Debug
Stop the timer and log the execution time.
$Image#typeProperty in class Image
The given image type.
$LegacyData#targetVersionProperty in class LegacyData
The target version that has to be supported.
$Page#tagsProperty in class Page
The $tags get also extracted from the text file (see $data).
$Pagelist#templateProperty in class Pagelist
The template to filter by the pagelist.
$Pagelist#typeProperty in class Pagelist
The pagelist's type (all pages, children pages or related pages)
PatternAssembly::template() — Method in class PatternAssembly
Return the regex to match any kind of Automad template such as variables, toolbox methods, includes, extensions, snippets, loops and conditions.
TemplateProcessorClass in namespace Automad\Engine\Processors
The main template processor.
ToolboxClass in namespace Automad\Engine
The Toolbox class holds all methods to be used within the template files.
ThemeCollectionClass in namespace Automad\System
The theme collection system class.
$ThemeCollection#themesProperty in class ThemeCollection
The Theme objects array.
$Update#timestampProperty in class Update
The update timestamp.
ThemeClass in namespace Automad\Types
The Theme type is a custom data type that stores all meta data of an installed theme.
$Theme#templatesProperty in class Theme
The templates array.
$Theme#tooltipsProperty in class Theme
The tooltips array.
$Response#triggerProperty in class Response
The output buffer used to store the event name that is triggered after sending a response.
Prefix::tags() — Method in class Prefix
Search for HTML tags in a string and replace the prefixes of UIkit classes and data attributes.
TextClass in namespace Automad\UI\Utils
The Text class provides all methods related to the text modules used in the UI.

U

$Automad#userProperty in class Automad
The username of the currently logged in user or false.
Debug::uc() — Method in class Debug
Log all user constants for get_defined_constants().
URLProcessorClass in namespace Automad\Engine\Processors
The URL processor class.
Runtime::unshelve() — Method in class Runtime
Restore shelved $data array by replacing it with the passed $shelf array.
Server::url() — Method in class Server
UpdateClass in namespace Automad\System
The Update class handles the process of updating Automad using the dashboard.
Update::unpack() — Method in class Update
Unpack all item matching AM_UPDATE_ITEM.
UserClass in namespace Automad\Types
The User type is a custom data type that stores all data that is related to a user.
UpdateClass in namespace Automad\UI\Commands
The update command.
FileCollectionController::upload() — Method in class FileCollectionController
Upload controller based on $_POST and $_FILES.
PackageManagerController::update() — Method in class PackageManagerController
Update a single package.
PackageManagerController::updateAll() — Method in class PackageManagerController
Update all packages.
SystemController::update() — Method in class SystemController
System updates.
UIControllerClass in namespace Automad\UI\Controllers
The UI controller class.
UserCollectionControllerClass in namespace Automad\UI\Controllers
The user collection class provides all methods for creating and loading user accounts.
UserControllerClass in namespace Automad\UI\Controllers
The User class provides all methods related to a user account.
FileCollectionModel::upload() — Method in class FileCollectionModel
Upload model.
LinksModel::update() — Method in class LinksModel
Update all links to a page or file after renaming or moving content.
PageModel::updateSlug() — Method in class PageModel
Update slug in case it is not a custom one and just represents a sanitized version of the title.
PageModel::updatePageLinks() — Method in class PageModel
Update all file and page links based on a new path.
PageModel::urlByPath() — Method in class PageModel
Return updated page URL based on $path.
$FileResultsModel#urlProperty in class FileResultsModel
The page URL or null for shared data.
UserCollectionModelClass in namespace Automad\UI\Models
The user collection model.
$UserCollectionModel#usersProperty in class UserCollectionModel
The collection of existing user objects.
$UserCollectionModel#userTypeProperty in class UserCollectionModel
The class name of the user type.
$UserCollectionModel#userTypeSerializedProperty in class UserCollectionModel
The replacement for the user type class in a serialized string.
UserModelClass in namespace Automad\UI\Models
The user model.
FileSystem::uniquePathSuffix() — Method in class FileSystem
Creates an unique suffix for a path to avoid conflicts with existing directories.
UICacheClass in namespace Automad\UI\Utils
The UI cache is the cache of the main Automad object including private pages that are only accessible when a user is logged in.
URLHashesClass in namespace Automad\UI\Utils
A collection of strings the define URL hashes to identify tabs or menu items consistently.

V

Image::verifyCachedImage() — Method in class Image
To verify, if the requested image is up to date, only the existence has to be tested, since any changes in the source image will be reflected in the filename's hash.
PatternAssembly::value() — Method in class PatternAssembly
Return the regex to match a single function parameter (pipe).
PatternAssembly::variable() — Method in class PatternAssembly
Return the regex for content variables.
PatternAssembly::variableKeyUI() — Method in class PatternAssembly
A simplified pattern to match all used variable names in a template (UI).
ViewClass in namespace Automad\Engine
The View class is responsible for rendering the requeste page.
$Theme#versionProperty in class Theme
The theme version.
User::verifyPassword() — Method in class User
Verify if a password matches its saved hashed version.
UserCollectionModel::validEmail() — Method in class UserCollectionModel
Verify if a given email address is valid.
UserCollectionModel::validUsername() — Method in class UserCollectionModel
Verify if a given username is valid.
UserModel::verifyPasswordResetToken() — Method in class UserModel
Verify if the passed username/toke combination matches a token hash in the session data array.

W

Cache::writeAutomadObjectToCache() — Method in class Cache
Write (serialize) the Automad object to $this->objectCacheFile.
Cache::writePageToCache() — Method in class Cache
Write the rendered HTML output to the cache file.
Cache::writeSiteMTime() — Method in class Cache
Write the site's modification time to the cache.
Config::write() — Method in class Config
Write the configuration file.
FileSystem::write() — Method in class FileSystem
Write content to a file and create the parent directory if needed.
$Image#widthProperty in class Image
The width of the generated image.
FileSystem::writeData() — Method in class FileSystem
Format, filter and write the data array a text file.

_

App::__construct() — Method in class App
The main app constructor takes care of running all required startup tests, initializing PHP sessions, setting up the autoloader, reading the configuration and displaying the final output for a request.
Automad::__construct() — Method in class Automad
Parse sitewide settings, create $collection and set the context to the currently requested page.
Automad::__sleep() — Method in class Automad
Define properties to be cached.
Automad::__wakeup() — Method in class Automad
Set new Context after being restored from cache.
Cache::__construct() — Method in class Cache
The constructor checks whether caching is enabled for the current request and determines the $pageCacheFile to make it available within the instance.
Context::__construct() — Method in class Context
The constructor.
Filelist::__construct() — Method in class Filelist
The constructor.
Image::__construct() — Method in class Image
The constructor defines the main object properties from the given parameters and initiates the main methods.
LegacyData::__construct() — Method in class LegacyData
The legacy data converter constructor.
Page::__construct() — Method in class Page
Set main properties.
Page::__get() — Method in class Page
Make basic data items accessible as page properties.
Pagelist::__construct() — Method in class Pagelist
Initialize the Pagelist.
RemoteFile::__construct() — Method in class RemoteFile
The constructor.
Router::__construct() — Method in class Router
The constructor.
Selection::__construct() — Method in class Selection
Pass a set of pages to $this->selection excluding all hidden pages.
Shared::__construct() — Method in class Shared
Parse the shared data file.
Sitemap::__construct() — Method in class Sitemap
The constructor verifies, whether sitemap.xml can be written and initiates the generating process.
Extension::__construct() — Method in class Extension
Create an instance of the given extension, call the extension method and look for all needed assets.
ContentProcessor::__construct() — Method in class ContentProcessor
The content processor constructor.
AbstractFeatureProcessor::__construct() — Method in class AbstractFeatureProcessor
The feature processor constructor.
PostProcessor::__construct() — Method in class PostProcessor
The post-processor constructor.
TemplateProcessor::__construct() — Method in class TemplateProcessor
The template processor constructor.
Runtime::__construct() — Method in class Runtime
The constructor.
Toolbox::__construct() — Method in class Toolbox
The Automad object is passed as an argument. It shouldn't be created again (performance).
View::__construct() — Method in class View
The view constructor.
Composer::__construct() — Method in class Composer
The constructor runs the setup.
ThemeCollection::__construct() — Method in class ThemeCollection
The constructor.
Theme::__construct() — Method in class Theme
The constructor.
User::__construct() — Method in class User
The constructor.
User::__serialize() — Method in class User
Serialize object.
User::__unserialize() — Method in class User
Unserialize object.
Console::__construct() — Method in class Console
The console constructor.
Dashboard::__construct() — Method in class Dashboard
The dashboard constructor.
ReplacementModel::__construct() — Method in class ReplacementModel
Initialize a new replacement model.
SearchModel::__construct() — Method in class SearchModel
Initialize a new search model for a search value, optionally used as a regular expression.
FieldResultsModel::__construct() — Method in class FieldResultsModel
Initialize a new field results instance.
FileKeysModel::__construct() — Method in class FileKeysModel
Initialize a new FileKeysModel instance.
FileResultsModel::__construct() — Method in class FileResultsModel
Initialize a new field results instance.
UserCollectionModel::__construct() — Method in class UserCollectionModel
The constructor.
Response::__construct() — Method in class Response
The output constructor.
Messenger::__construct() — Method in class Messenger
The messenger constructor.