Documentation

Documentation

Table of Contents

Packages

Application
Grav
RocketTheme
Slim
Helper

Namespaces

Grav
Twig
Helper
PHPStan

Classes

DOMLettersIterator
Iterates individual characters (Unicode codepoints) of DOM text and CDATA nodes while keeping track of their position in the document.
DOMWordsIterator
Iterates individual words of DOM text and CDATA nodes while keeping track of their position in the document.
AcceptanceTester
Inherited Methods
FunctionalTester
Inherited Methods
UnitTester
Inherited Methods
DirectInstallCommandTest
Class DirectInstallCommandTest
AssetsTest
Class AssetsTest
BrowserTest
Class BrowserTest
ComposerTest
BlueprintTest
Class InstallCommandTest
GpmStub
Class GpmStub
GpmTest
Class InstallCommandTest
ExcerptsTest
Class ExcerptsTest
InflectorTest
Class InflectorTest
LanguageCodesTest
Class ParsedownTest
ParsedownTest
Class ParsedownTest
PagesTest
Class PagesTest
GravExtensionTest
Class GravExtensionTest
UriTest
Class UriTest
UtilsTest
Class UtilsTest
InstallCommandTest
Class InstallCommandTest
CsvFormatterTest
Class CsvFormatterTest
FilesystemTest
Class FilesystemTest

Constants

ACCOUNTS_DIR  = \USER_DIR . 'accounts/'
ASSETS_DIR  = \GRAV_WEBROOT . '/assets/'
CACHE_DIR  = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_CACHE_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_CACHE_PATH . '/'
CACHE_PATH  = \GRAV_CACHE_PATH . \DS
CONTENT_EXT  = '.md'
DATA_DIR  = \USER_DIR . 'data/'
DS  = '/'
EXCEPTION_BAD_FORMAT  = 1
EXCEPTION_INCOMPATIBLE_VERSIONS  = 2
GANTRY5_DEBUG  = \true
GANTRY5_PLATFORM  = 'grav'
GANTRY5_ROOT  = \GRAV_ROOT
GANTRY5_VERSION  = '@version@'
GANTRY5_VERSION_DATE  = '@versiondate@'
GANTRY_DEBUGGER  = \true
GANTRYADMIN_PATH  = ''
GIT_REGEX  = '/http[s]?:\/\/(?:.*@)?(github|bitbucket)(?:.org|.com)\/.*\/(.*)/'
GRAV  = \true
GRAV_BACKUP_PATH  = $path
GRAV_CACHE_PATH  = $path
GRAV_CLI  = \true
GRAV_CLI  = \true
GRAV_LOG_PATH  = $path
GRAV_PHP_MIN  = '7.3.6'
GRAV_PHP_MIN  = '7.3.6'
GRAV_REQUEST_TIME  = microtime(true)
GRAV_REQUEST_TIME  = $this->currentTime
GRAV_REQUEST_TIME  = \microtime(\true)
GRAV_REQUEST_TIME  = \microtime(\true)
GRAV_ROOT  = $path ?: \DS
GRAV_ROOT  = \str_replace(\DIRECTORY_SEPARATOR, '/', \getcwd()) . $grav_basedir
GRAV_SANITIZE_STRING  = 5001
GRAV_SCHEMA  = '1.7.0_2020-11-20_1'
GRAV_SYSTEM_PATH  = $path
GRAV_TESTING  = \false
GRAV_TMP_PATH  = $path
GRAV_USER_INSTANCE  = 'REGULAR'
GRAV_USER_INSTANCE  = 'FLEX'
To help phpstan dealing with LogicException in Common\User\User.php
GRAV_USER_INSTANCE  = 'FLEX'
GRAV_USER_PATH  = $path
GRAV_VERSION  = '1.7.49.5'
GRAV_WEBROOT  = $path ?: \DS
IMAGES_DIR  = \GRAV_WEBROOT . '/images/'
LIB_DIR  = \SYSTEM_DIR . 'src/'
LOG_DIR  = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_LOG_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_LOG_PATH . '/'
PAGE_ORDER_PREFIX_REGEX  = '/^[0-9]+\./u'
PAGES_DIR  = \USER_DIR . 'pages/'
PLUGIN_EXT  = '.php'
PLUGINS_DIR  = \USER_DIR . 'plugins/'
RAW_CONTENT  = 1
ROOT_DIR  = \GRAV_ROOT . \DS
SYSTEM_DIR  = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_SYSTEM_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_SYSTEM_PATH . '/'
TEMPLATE_EXT  = '.html.twig'
THEMES_DIR  = \USER_DIR . 'themes/'
TWIG_CONTENT  = 2
TWIG_CONTENT_LIST  = 3
TWIG_EXT  = '.twig'
TWIG_TEMPLATES  = 4
USER_DIR  = \GRAV_WEBROOT . '/' . \GRAV_USER_PATH . '/'
USER_PATH  = \GRAV_USER_PATH . \DS
VENDOR_DIR  = \GRAV_ROOT . '/vendor/'
YAML_EXT  = '.yaml'

Constants

ACCOUNTS_DIR

public mixed ACCOUNTS_DIR = \USER_DIR . 'accounts/'

ASSETS_DIR

public mixed ASSETS_DIR = \GRAV_WEBROOT . '/assets/'

CACHE_DIR

public mixed CACHE_DIR = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_CACHE_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_CACHE_PATH . '/'

CACHE_PATH

public mixed CACHE_PATH = \GRAV_CACHE_PATH . \DS

CONTENT_EXT

public mixed CONTENT_EXT = '.md'

DATA_DIR

public mixed DATA_DIR = \USER_DIR . 'data/'

EXCEPTION_BAD_FORMAT

public mixed EXCEPTION_BAD_FORMAT = 1

EXCEPTION_INCOMPATIBLE_VERSIONS

public mixed EXCEPTION_INCOMPATIBLE_VERSIONS = 2

GIT_REGEX

public mixed GIT_REGEX = '/http[s]?:\/\/(?:.*@)?(github|bitbucket)(?:.org|.com)\/.*\/(.*)/'

GRAV

public mixed GRAV = \true
Tags
copyright

Copyright (c) 2015 - 2025 Trilby Media, LLC. All rights reserved.

license

MIT License; see LICENSE file for details.

GRAV_BACKUP_PATH

public mixed GRAV_BACKUP_PATH = $path

GRAV_CACHE_PATH

public mixed GRAV_CACHE_PATH = $path

GRAV_LOG_PATH

public mixed GRAV_LOG_PATH = $path

GRAV_PHP_MIN

public mixed GRAV_PHP_MIN = '7.3.6'

GRAV_PHP_MIN

public mixed GRAV_PHP_MIN = '7.3.6'

GRAV_REQUEST_TIME

public mixed GRAV_REQUEST_TIME = microtime(true)

GRAV_REQUEST_TIME

public mixed GRAV_REQUEST_TIME = $this->currentTime

GRAV_ROOT

public mixed GRAV_ROOT = $path ?: \DS

GRAV_ROOT

public mixed GRAV_ROOT = \str_replace(\DIRECTORY_SEPARATOR, '/', \getcwd()) . $grav_basedir

GRAV_SANITIZE_STRING

public mixed GRAV_SANITIZE_STRING = 5001

GRAV_SCHEMA

public mixed GRAV_SCHEMA = '1.7.0_2020-11-20_1'

GRAV_SYSTEM_PATH

public mixed GRAV_SYSTEM_PATH = $path

GRAV_TESTING

public mixed GRAV_TESTING = \false

GRAV_TMP_PATH

public mixed GRAV_TMP_PATH = $path

GRAV_USER_INSTANCE

To help phpstan dealing with LogicException in Common\User\User.php

public mixed GRAV_USER_INSTANCE = 'FLEX'

GRAV_USER_PATH

public mixed GRAV_USER_PATH = $path

GRAV_VERSION

public mixed GRAV_VERSION = '1.7.49.5'

GRAV_WEBROOT

public mixed GRAV_WEBROOT = $path ?: \DS

IMAGES_DIR

public mixed IMAGES_DIR = \GRAV_WEBROOT . '/images/'

LIB_DIR

public mixed LIB_DIR = \SYSTEM_DIR . 'src/'

LOG_DIR

public mixed LOG_DIR = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_LOG_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_LOG_PATH . '/'

PAGE_ORDER_PREFIX_REGEX

public mixed PAGE_ORDER_PREFIX_REGEX = '/^[0-9]+\./u'

PAGES_DIR

public mixed PAGES_DIR = \USER_DIR . 'pages/'

PLUGIN_EXT

public mixed PLUGIN_EXT = '.php'

PLUGINS_DIR

public mixed PLUGINS_DIR = \USER_DIR . 'plugins/'

RAW_CONTENT

public mixed RAW_CONTENT = 1

ROOT_DIR

public mixed ROOT_DIR = \GRAV_ROOT . \DS

SYSTEM_DIR

public mixed SYSTEM_DIR = (!\preg_match('`^(/|[a-z]:[\\\\/])`ui', \GRAV_SYSTEM_PATH) ? \GRAV_ROOT . '/' : '') . \GRAV_SYSTEM_PATH . '/'

TEMPLATE_EXT

public mixed TEMPLATE_EXT = '.html.twig'

THEMES_DIR

public mixed THEMES_DIR = \USER_DIR . 'themes/'

TWIG_CONTENT

public mixed TWIG_CONTENT = 2

TWIG_CONTENT_LIST

public mixed TWIG_CONTENT_LIST = 3

TWIG_EXT

public mixed TWIG_EXT = '.twig'

TWIG_TEMPLATES

public mixed TWIG_TEMPLATES = 4

USER_DIR

public mixed USER_DIR = \GRAV_WEBROOT . '/' . \GRAV_USER_PATH . '/'

USER_PATH

public mixed USER_PATH = \GRAV_USER_PATH . \DS

VENDOR_DIR

public mixed VENDOR_DIR = \GRAV_ROOT . '/vendor/'

YAML_EXT

public mixed YAML_EXT = '.yaml'

Search results