API Documentation
Table of Contents
Namespaces
Constants
- CPPAGE_ACCOUNT = '../Plugins/ControlPanel/Views/Account.php'
- CPPAGE_LOGIN = '../Plugins/ControlPanel/Views/Login.php'
- CPPAGE_LOGOUT = '../Plugins/ControlPanel/Views/Logout.php'
- CPPAGE_NOACCESS = '../Plugins/ControlPanel/Views/NoAccess.php'
- CPPAGE_REGISTER = '../Plugins/ControlPanel/Views/Join.php'
- CPURL_ACCOUNT = '/account'
- CPURL_EDIT = '/edit'
- CPURL_JOIN = '/join'
- CPURL_LOGOUT = '/logout'
- CPURL_PAGES = '/pages'
- CPURL_PANEL = '/panel'
- CPURL_PLUGINS = '/plugins'
- CPURL_USERS = '/users'
- DB_CHARSET = 'utf8mb4'
- DB_HOST = 'localhost'
- DB_NAME = 'Saturn'
- DB_OPTIONS = [\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC, \PDO::ATTR_EMULATE_PREPARES => \false]
- DB_PASS = ''
- DB_PORT = 3306
- DB_PREFIX = 'saturn_'
- DB_TYPE = 'MySQLi'
- DB_USER = 'root'
- DEV_SHOW_PLUGINS = 0
- Saturn Developer Settings.
- ENV_DEV = 1
- ENV_PROD = 0
- MODE_LIVE = 0
- MODE_MAINT = 1
- SATSYS_DISALLOWED_PAGES = ['Assets', 'Plugins', 'Processes', 'Settings', 'Storage', 'Themes', 'panel', 'account', 'api']
- SATSYS_DOCS_URL = 'https://docs.saturncms.net/v/' . \SATSYS_VERSION
- SATSYS_MINIMUM_PHP = 8
- SATSYS_RECOMMENDED_PHP = 8.1
- SATSYS_VERSION = '1.0.0'
- SATURN_LANGUAGE = 'en-gb'
- SATURN_ROOT = ''
- SECURITY_PASSWORD_ALGORITHM = \PASSWORD_DEFAULT
- SECURITY_TOKEN_ALGORITHM = \PASSWORD_DEFAULT
- WEBSITE_CHARSET = 'utf-8'
- WEBSITE_ENV = \ENV_PROD
- WEBSITE_LANGUAGE = 'en-gb'
- WEBSITE_MODE = \MODE_LIVE
- WEBSITE_NAME = 'Saturn'
- WEBSITE_SALT = 'CHANGE_ME'
- Saturn Settings.
Functions
- __CP() : string
- SaturnEnd() : void
- Out() : string
- __() : string
Constants
CPPAGE_ACCOUNT
public
mixed
CPPAGE_ACCOUNT
= '../Plugins/ControlPanel/Views/Account.php'
CPPAGE_LOGIN
public
mixed
CPPAGE_LOGIN
= '../Plugins/ControlPanel/Views/Login.php'
CPPAGE_LOGOUT
public
mixed
CPPAGE_LOGOUT
= '../Plugins/ControlPanel/Views/Logout.php'
CPPAGE_NOACCESS
public
mixed
CPPAGE_NOACCESS
= '../Plugins/ControlPanel/Views/NoAccess.php'
CPPAGE_REGISTER
public
mixed
CPPAGE_REGISTER
= '../Plugins/ControlPanel/Views/Join.php'
CPURL_ACCOUNT
public
mixed
CPURL_ACCOUNT
= '/account'
CPURL_EDIT
public
mixed
CPURL_EDIT
= '/edit'
CPURL_JOIN
public
mixed
CPURL_JOIN
= '/join'
CPURL_LOGOUT
public
mixed
CPURL_LOGOUT
= '/logout'
CPURL_PAGES
public
mixed
CPURL_PAGES
= '/pages'
CPURL_PANEL
public
mixed
CPURL_PANEL
= '/panel'
CPURL_PLUGINS
public
mixed
CPURL_PLUGINS
= '/plugins'
CPURL_USERS
public
mixed
CPURL_USERS
= '/users'
DB_CHARSET
public
mixed
DB_CHARSET
= 'utf8mb4'
DB_HOST
public
mixed
DB_HOST
= 'localhost'
DB_NAME
public
mixed
DB_NAME
= 'Saturn'
DB_OPTIONS
public
mixed
DB_OPTIONS
= [\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC, \PDO::ATTR_EMULATE_PREPARES => \false]
DB_PASS
public
mixed
DB_PASS
= ''
DB_PORT
public
mixed
DB_PORT
= 3306
DB_PREFIX
public
mixed
DB_PREFIX
= 'saturn_'
DB_TYPE
public
mixed
DB_TYPE
= 'MySQLi'
DB_USER
public
mixed
DB_USER
= 'root'
DEV_SHOW_PLUGINS
Saturn Developer Settings.
public
mixed
DEV_SHOW_PLUGINS
= 0
DO NOT EDIT THIS FILE IN A TEXT EDITOR
YOUR WEBSITE MUST BE SET TO DEVELOPER ENVIRONMENT FOR THESE SETTINGS TO APPLY. THESE SETTINGS WILL BE IGNORED IN A PRODUCTION ENVIRONMENT FOR SECURITY REASONS.
ENV_DEV
public
mixed
ENV_DEV
= 1
ENV_PROD
public
mixed
ENV_PROD
= 0
MODE_LIVE
public
mixed
MODE_LIVE
= 0
MODE_MAINT
public
mixed
MODE_MAINT
= 1
SATSYS_DISALLOWED_PAGES
public
mixed
SATSYS_DISALLOWED_PAGES
= ['Assets', 'Plugins', 'Processes', 'Settings', 'Storage', 'Themes', 'panel', 'account', 'api']
SATSYS_DOCS_URL
public
mixed
SATSYS_DOCS_URL
= 'https://docs.saturncms.net/v/' . \SATSYS_VERSION
SATSYS_MINIMUM_PHP
public
mixed
SATSYS_MINIMUM_PHP
= 8
SATSYS_RECOMMENDED_PHP
public
mixed
SATSYS_RECOMMENDED_PHP
= 8.1
SATSYS_VERSION
public
mixed
SATSYS_VERSION
= '1.0.0'
SATURN_LANGUAGE
public
mixed
SATURN_LANGUAGE
= 'en-gb'
SATURN_ROOT
public
mixed
SATURN_ROOT
= ''
SECURITY_PASSWORD_ALGORITHM
public
mixed
SECURITY_PASSWORD_ALGORITHM
= \PASSWORD_DEFAULT
SECURITY_TOKEN_ALGORITHM
public
mixed
SECURITY_TOKEN_ALGORITHM
= \PASSWORD_DEFAULT
WEBSITE_CHARSET
public
mixed
WEBSITE_CHARSET
= 'utf-8'
WEBSITE_ENV
public
mixed
WEBSITE_ENV
= \ENV_PROD
WEBSITE_LANGUAGE
public
mixed
WEBSITE_LANGUAGE
= 'en-gb'
WEBSITE_MODE
public
mixed
WEBSITE_MODE
= \MODE_LIVE
WEBSITE_NAME
public
mixed
WEBSITE_NAME
= 'Saturn'
WEBSITE_SALT
Saturn Settings.
public
mixed
WEBSITE_SALT
= 'CHANGE_ME'
DO NOT EDIT THIS FILE IN A TEXT EDITOR
Functions
__CP()
__CP(string $Key) : string
Parameters
- $Key : string
Return values
stringSaturnEnd()
SaturnEnd() : void
Out()
Out(string $Text) : string
Parameters
- $Text : string
Return values
string__()
__(string $Text) : string
Parameters
- $Text : string