Documentation

Application

Interfaces

PdbExceptionInterface
TransactionException: Just an interface to match both query and recursion type transaction errors.
JsExpression: For use with Js::encode().
JsonDeserializable: An object that can be deserialized from a JSON array.
RdbJsonObject: Implement this interface to create a JSON object that can be stored by Rdb.
HttpExceptionInterface: These are errors that can inform the status code.
AiApiInterface: Base class to ensure common functions for API tooling
ArchiveDriver: Archive driver interface.
CacheDriver: Cache driver interface.
SessionDriver: Session driver interface
FindReplaceInterface: This is a base class for find-replace behaviours, aka. the doomtool.
FrontEndEntrance: Defines that a specific controller is able to handle front-end entrances from the pages module
FrontEndSearch
ImageTransform: Does image resizing, or whatever transforms wanted really.
ModerateInterface: A moderation component.
ModuleInterface: Interface for SproutCMS modules.
TreenodeMatcher: Interface for matching nodes in the treenode
WorkerInterface: Interface for worker jobs.
WorkerJobInterface: Interface for worker jobs.

Classes

DatabaseSync: Database sync.
PdbNoDriver: Class for doing database queries via PDO (PDO Database => Pdb)
ConnectionException: Exception thrown when a connection fails.
ConstraintQueryException: Exception thrown when a database query fails due to an integrity constraint violation
DataQueryException: Exception thrown when a database query encounters a data error.
InvalidConditionException
PdbException
PdbParserException
QueryException: Exception thrown when a database query fails, or gives an empty result set for a query which required a row to be returned
RowMissingException: Exception thrown when a database query gives an empty result set for a query which required a row to be returned
TransactionEmptyException: Exception thrown when no transaction is active.
TransactionNameException: Exception thrown when an invalid transaction/savepoint name is used.
TransactionQueryException: Exception thrown when a database query encounters a transaction errors.
TransactionRecursionException: Exception thrown when an attempt is made to start a transaction from within an existing transaction
PdbJsonDefault: Represents a possible JSON value for an array property
PdbParser: Provides a system for syncing a database to a database definition.
PdbSetDefaults: Represents the plural default values of a SET column
PdbSync: Provides a system for syncing a database to a database definition.
Buffer: A wrapper for the PHP output buffer.
Config: A config helper.
Encrypt: The Encrypt library provides two-way encryption of text and binary strings using the openSSL extension.
RulesValidator: Rules based validation processor.
Shell: Utilities for doing shell things.
RdbSessionHandler: A session handler for Rdb.
StaticRdb: Static version of Rdb.
BootstrapConfig: Methods for determining the details of the very initial environment, prior to the rest of the system coming up
PHPUnit_Framework_TestCase
ActionLogAdminController: Handles admin processing for the action log, which is a record of changes to database content
CategoryAdminController: This is a generic controller which category controllers should extend.
ContentSubscriptionAdminController: This is a generic controller which all controllers which are managed in the admin area should extend.
CronJobAdminController: Handles most processing for Cron Jobs
DocumentTypeAdminController: Handles admin processing for Document types
EmailReportAdminController: Handles admin processing for Email reports
EmailTextAdminController: Handles most processing for Email text
ExtraPageAdminController: Handles most processing for Extra pages
FileAdminController: Handles most of the processing for files
FileCategoryAdminController: Handles categories for files
HasCategoriesAdminController: An abstract class for controllers of things which have categories.
ListAdminController: Any controller which is essentially a short list of items, which are not substantial enough to warrant a categories system
ManagedAdminController: This is a generic controller which all controllers which are managed in the admin area should extend.
MySettingsAdminController: Changes settings for the currently logged in user
NoRecordsAdminController: Provides a base class for controllers which don't manage records, but are just a set of tools
OperatorAdminController: Handles most processing for operators
OperatorCategoryAdminController: Handles most processing for operator categories
PageAdminController: Handles admin processing for pages
PerRecordPermissionAdminController: Manages which controllers have per-record permissions enabled
RedirectAdminController: Handles most processing for Redirects
RedirectCategoryAdminController: Handles most processing for Redirect categories
SimpleListAdminController: Any controller which is essentially a short list of items, which are not substantial enough to warrant a categories system
SiteSettingAdminController: Handles admin processing for Document types
SubsiteAdminController: Handles most processing for Subsites
TagAdminController: Admin UI for managing Sprout Tags
TreeAdminController: Any controller which is essentially a tree-based structure of nodes and sub-nodes.
WorkerJobAdminController: Handles most processing for Worker Jobs
AdminAjaxController: Handles processing of various admin AJAX methods including: widget settings; links; and categories.
AdminController: Main class to handle admin processing.
AdvancedSearchController: - No description yet -
AppController: Generic public utilities
CaptchaController: Used for generating CAPTCHA images and explanatory text
ContentSubscribeController: Handles subscriptions to various types of content in a centralised manner
Controller: Kohana Controller class. The controller class must be extended to work properly, so this class is defined as abstract.
CronJobController: Runs scheduled tasks assigned by {@see Register::cronJob} on behalf of the UN*X cron utility
DbToolsController: Provides tools for dealing with the database Tools include a sync tool and a structure viewer
EmailShareController: - No description yet -
EmbedVideoController: Dynamic cropping for video thumbs
FileController: Provides access to file and image data
FileUploadController: Handles file uploads in chunks using the JS File API and XMLHttpRequest
LocaleController: For things related to Locales
MediaController: Serving media assets.
MediaMushController: - No description yet -
MultiStepFormController: Supports multistep forms
PageController: Handles front-end processing for pages
ResultController: Used to handle generic success and error messages after processing a POST submission, when there isn't a particularly good URL to redirect to.
SearchController: Performs site-wide searches
SeoController: Handler for SEO functions, including generation of robots.txt and XML sitemap
Tinymce4Controller: Link library, image library, etc
WorkerJobController: Runs worker jobs (i.e. Helpers which extend {@see WorkerBase})
Kohana_Exception: Creates a generic i18n exception.
Kohana_User_Exception: Creates a custom exception.
Kohana_404_Exception: Creates a Page Not Found exception.
AfterActionEvent: An abstract base event.
BeforeActionEvent: An abstract base event.
DisplayEvent: An abstract base event.
ErrorEvent: An abstract base event.
NotFoundEvent: An abstract base event.
PostControllerConstructorEvent: An abstract base event.
PostControllerEvent: An abstract base event.
PostRoutingEvent: An abstract base event.
PreControllerEvent: An abstract base event.
PreRoutingEvent: An abstract base event.
RedirectEvent: An abstract base event.
SendHeadersEvent: An abstract base event.
SessionWriteEvent: An abstract base event.
ShutdownEvent: An abstract base event.
ConstraintQueryException: Exception thrown when a database query fails due to an integrity constraint violation
CorsException: Exception thrown when a CORS request fails.
FileConversionException: Exception thrown while using the FileConvert helper
FileException: Common parent for file exceptions.
FileMissingException: Exception thrown when a file doesn't exist
FileTransformException: Errors from the FileTransform helper.
FileUploadException: Exception thrown when a (chunked) file upload fails
ImageException: Exceptions for describing image processing errors.
JwtException
MediaException: An error when processing a media resources.
MediaMissingException: The media file is missing.
QueryException: Exception thrown when a database query fails, or gives an empty result set for a query which required a row to be returned
RowMissingException: Exception thrown when a database query gives an empty result set for a query which required a row to be returned
SignatureInvalidException: Exception thrown when a database query gives an empty result set for a query which required a row to be returned
TransactionRecursionException: Exception thrown when an attempt is made to start a transaction from within an existing transaction
ValidationException: Validator errors.
WorkerJobException: Exception thrown when a database query fails, or gives an empty result set for a query which required a row to be returned
Admin: Useful functions for the admin
AdminAuth: Provides user authentication functions for the admin
AdminDashboard: Dashboard shown when a user first logs in to the admin
AdminError: Handles errors in the admin.
AdminPerms: Provides user permisison functions for the admin
AdminSeo: Provide Search Engine Optimisation functionality
AI: General helpers for AI system
OpenAiApi: General helper tools for interacting with the OpenAI API
WorkerAiContentProcess: Base class for worker jobs, which are run via CLI in a separate process
WorkerOpenAiPurge: Base class for worker jobs, which are run via CLI in a separate process
Archive: Class for creating archives in various formats - zip, tar.bz2, etc
AttrEditor: Specialised input field for page attributes
AttrEditorBinary: Specialised input field for page attributes
AttrEditorFilename: Specialised file selector input field for page attributes
AttrEditorImage: Specialised image selector input field for page attributes
AttrEditorMultiline: Specialised multiline text input field for page attributes
AttrEditorTextbox: Specialised text input field for page attributes
Auth: Provides user authentication functions for the admin
Aws: Core tooling for using the AWS SDK
CloudFront: A simple wrapper for loading S3 ready for use with the AWS SDK
Iam: A simple wrapper for loading Iam ready for use with the AWS SDK
S3: A simple wrapper for loading S3 ready for use with the AWS SDK
BaseView: Loads and displays Kohana view files.
BbCode
Cache: Provides a driver-based interface for finding, creating, and deleting cached resources. Caches are identified by a unique string. Tagging of caches is also supported, and caches can be found and deleted by id or tag.
Calendar: Renders a calendar
Captcha: Means to generate and process CAPTCHAs of various implementations
Category
ColModifier: Base class for modifying values for main_columns of an {@see ItemList}, e.g. in {@see ManagedAdminController::_getContents}
ColModifierActionLogData: Tries to extract a name from an action log entry to display with an ID
ColModifierBinary: Extend this instead of ColModifier, if your output sort order matches the database sort order.
ColModifierByteSize: Extend this instead of ColModifier, if your output sort order matches the database sort order.
ColModifierContentSubscription: Base class for modifying values for main_columns of an {@see ItemList}, e.g. in {@see ManagedAdminController::_getContents}
ColModifierDate: Converts a MySQL date into something friendlier. Works for DATE, TIME, DATETIME AND [BIG]INT.
ColModifierDuplicate: Count duplicates in a column.
ColModifierFilename: Extend this instead of ColModifier, if your output sort order matches the database sort order.
ColModifierHexIP: Converts a hex-packed IP back into readable form
ColModifierImage: Extend this instead of ColModifier, if your output SHOULD NOT be escaped, i.e. it is already HTML
ColModifierLnk: Formats a Lnk field into something appealing
ColModifierLookupArray: Returns data straight from an array (e.g. constants)
ColModifierLookupTable: Returns data from a database table.
ColModifierMoney: Extend this instead of ColModifier, if your output sort order matches the database sort order.
ColModifierSize: Converts byte value into human readable sizes
ColModifierSprintf: Format something using printf syntax.
ColModifierSubRecordCount: Counts records in a subtable.
ColModifierTruncate: Truncate the word count of a column with given word limit trailed by ellipsis symbol, with the full text in a title attribute
Constants: A bunch of different constants
ContentReplace: No description yet.
ContentSubscribe
Cookie: Eases reading and writing cookies.
CoreAdminAuth: Provides user authentication functions for the admin
Cors: Cross Origin Resource Sharing.
CountryConstants: Generated class containing ISO-3166 country mappings for alpha-2 and alpha-3
Cron: Methods for initialising, recording the progress of, and finalising and cron scripts
CropImageTransform: Does image resizing, etc
Csrf: Protection against Cross Site Request Forgery (CSRF) attacks
CustomHeadTags: Management of custom HEAD tags. Often meta but can also be link, base, etc
DatabaseSync: Provides a system for syncing a database to a database definition.
Debug: Useful methods for debugging
DefaultCaptcha: Default Sprout CAPTCHA; doesn't need to talk to external servers
Referrer: Display condtion for the full HTTP referrer when the session started
UtmCampaign: Display condtion for the 'utm_campaign' field
UtmMedium: Display condtion for the 'utm_medium' field
UtmSource: Display condtion for the 'utm_source' field
DisplayCondition: Base class for display conditions
DisplayConditionEnum: Display condition for enumerations - where the set of parameter values is fixed and always equals or not equals
DisplayConditionInteger: Display condition for integers
DisplayConditionString: Display condition for integers
BrowserName: Display condtion for browser - firefox, chrome, safari, etc
BrowserVersion: Display condition for browser version - 3, 4, 5, etc Test is integerised, so therefore only checks the major number Only makes sense when a conditon for the browser itself is also selected
DeviceCategory: Display condtion for device category - desktop, mobile, tablet
ThisPageviews: Display condtion for number of times this page has been viewed
TimeOnSite: Display condtion for time on site in minutes
TotalPageviews: Display condition for total pageviews this session
UniquePageviews: Display condition for unique pageviews this session
DocImport: Abstract class with additional stuff for the document importer system
DocImportCSV: Abstract class with additional stuff for the document importer system
DocImportDOCX: Abstract class with additional stuff for the document importer system
DocImportDOCXRun
DocImportPlaintext: Abstract class with additional stuff for the document importer system
Bzip: Archive library bzip driver.
Gzip: Archive library gzip driver.
Tar: Archive library tar driver.
Zip: Archive library zip driver.
File: File-based Cache driver.
Memcache: Memcache-based Cache driver.
Rdb: Redis-based Cache driver.
GD: GD Image Driver.
GraphicsMagick: GraphicsMagick Image Driver.
ImageMagick: ImageMagick Image Driver.
ImageDriver: Image API driver.
Cache: Session cache driver.
Database: Session database driver.
Email: Sends emails using HTML content generated by a View, wrapped in a standard template
EmailText
EmailTextReg
EmbedVideo: No description yet.
Enc: Encoding of data for various outputs
Encrypt: The Encrypt library provides two-way encryption of text and binary strings using the openSSL extension.
Export
ExportTable
ExportTableSQL
Fb: Quick and easy form builder
FileConstants: A bunch of different constants
FileConvert: Converter between various file types
FileIndexing: Does indexing for various file formats
FilesBackend: Abstract class for a backend storage for the database-managed files
FilesBackendDirectory: Backend for the files module which stores files in a local directory
FilesBackendS3: Backend for the files module which stores files in a local directory.
FileStream: Stream that wraps PHP files.
FileTransform: Methods for file resizing
FileUpload: Used for managing backend processing of fields which have had data submitted via chunked file uploads, i.e. where chunked upload data has been stitched together by {@see FileUploadController}
FindReplace: The tool of doom.
FindReplaceHtmlCode: A doomtool for HTML code widgets.
FindReplaceRichText: A doomtool for rich text widgets.
FindReplaceText: A doomtool for plaintext database columns.
FindReplaceWidget: A base class for widget doomtools.
Form: Helper functions for outputting form elements.
FormSession
GeoSeach
Honeypot: Honeypots for hungry bots.
Html: Helper functions for outputting HTML elements.
HttpReq: Simple HTTP(s) request wrapper
I18n: Formats data according to local conventions.
Image: Manipulate images using standard methods such as resize, crop, rotate, etc.
ImportCMS
ImportCSV: Facilitates the cimple importing of CSV files Loads up the CSV and allows for sequential reading of the file as data records.
Inflector: Language inflection such as pluralisation.
Itemlist: Used to generate HTML for a table of database records.
Jquery: Simple class to ensure uniform jQuery version(s) used
JsErrors: Utilities for frontend error logging.
Json: Methods for handling JSON output, usually for AJAX responses
JsonForm: Processes forms using configuration stored in a JSON file which specifies database columns, their HTML input fields, and validation rules.
Jwt: Common Jws/Jwt methods
LaunchChecks
LightweightForm: A variation of the {@see Form} helper which doesn't output errors, labels or helptext Wraps form fields (e.g. from {@see Fb}) with additional HTML.
LinkSpec: Base class for the backend of the extensible link system: {@see Lnk}
LinkSpecDocument: Base class for the backend of the extensible link system: {@see Lnk}
LinkSpecExternal: Base class for the backend of the extensible link system: {@see Lnk}
LinkSpecInternal: Base class for the backend of the extensible link system: {@see Lnk}
LinkSpecPage: Base class for the backend of the extensible link system: {@see Lnk}
Lnk: This is a system of portable, extensible link management.
LocaleInfo: Class to handle locale-dependent data such as addresses and currency
LocaleInfoAFG: Locale info for Afghanistan; see {@see LocaleInfo}
LocaleInfoAGO: Locale info for Angola; see {@see LocaleInfo}
LocaleInfoALB: Locale info for Albania; see {@see LocaleInfo}
LocaleInfoAND: Locale info for Andorra; see {@see LocaleInfo}
LocaleInfoARE: Locale info for United Arab Emirates; see {@see LocaleInfo}
LocaleInfoARG: Locale info for Argentina; see {@see LocaleInfo}
LocaleInfoARM: Locale info for Armenia; see {@see LocaleInfo}
LocaleInfoATA: Locale info for Antarctica; see {@see LocaleInfo}
LocaleInfoATG: Locale info for Antigua and Barbuda; see {@see LocaleInfo}
LocaleInfoAUS: Locale info for Australia; see {@see LocaleInfo}
LocaleInfoAUT: Locale info for Austria; see {@see LocaleInfo}
LocaleInfoAZE: Locale info for Azerbaijan; see {@see LocaleInfo}
LocaleInfoBDI: Locale info for Burundi; see {@see LocaleInfo}
LocaleInfoBEL: Locale info for Belgium; see {@see LocaleInfo}
LocaleInfoBEN: Locale info for Benin; see {@see LocaleInfo}
LocaleInfoBES: Locale info for Caribbean Netherlands; see {@see LocaleInfo}
LocaleInfoBFA: Locale info for Burkina Faso; see {@see LocaleInfo}
LocaleInfoBGD: Locale info for Bangladesh; see {@see LocaleInfo}
LocaleInfoBGR: Locale info for Bulgaria; see {@see LocaleInfo}
LocaleInfoBHR: Locale info for Bahrain; see {@see LocaleInfo}
LocaleInfoBHS: Locale info for Bahamas; see {@see LocaleInfo}
LocaleInfoBIH: Locale info for Bosnia and Herzegovina; see {@see LocaleInfo}
LocaleInfoBLR: Locale info for Belarus; see {@see LocaleInfo}
LocaleInfoBLZ: Locale info for Belize; see {@see LocaleInfo}
LocaleInfoBOL: Locale info for Bolivia; see {@see LocaleInfo}
LocaleInfoBRA: Locale info for Brazil; see {@see LocaleInfo}
LocaleInfoBRB: Locale info for Barbados; see {@see LocaleInfo}
LocaleInfoBRN: Locale info for Brunei Darussalam; see {@see LocaleInfo}
LocaleInfoBTN: Locale info for Bhutan; see {@see LocaleInfo}
LocaleInfoBWA: Locale info for Botswana; see {@see LocaleInfo}
LocaleInfoCAF: Locale info for Central African Republic; see {@see LocaleInfo}
LocaleInfoCAN: Locale info for Canada; see {@see LocaleInfo}
LocaleInfoCHE: Locale info for Switzerland; see {@see LocaleInfo}
LocaleInfoCHL: Locale info for Chile; see {@see LocaleInfo}
LocaleInfoCHN: Locale info for China; see {@see LocaleInfo}
LocaleInfoCIV: Locale info for Côte d'Ivoire; see {@see LocaleInfo}
LocaleInfoCMR: Locale info for Cameroon; see {@see LocaleInfo}
LocaleInfoCOD: Locale info for DR Congo; see {@see LocaleInfo}
LocaleInfoCOG: Locale info for Congo; see {@see LocaleInfo}
LocaleInfoCOL: Locale info for Colombia; see {@see LocaleInfo}
LocaleInfoCOM: Locale info for Comoros; see {@see LocaleInfo}
LocaleInfoCPV: Locale info for Cape Verde; see {@see LocaleInfo}
LocaleInfoCRI: Locale info for Costa Rica; see {@see LocaleInfo}
LocaleInfoCUB: Locale info for Cuba; see {@see LocaleInfo}
LocaleInfoCYP: Locale info for Cyprus; see {@see LocaleInfo}
LocaleInfoCZE: Locale info for Czech Republic; see {@see LocaleInfo}
LocaleInfoDEU: Locale info for Germany; see {@see LocaleInfo}
LocaleInfoDJI: Locale info for Djibouti; see {@see LocaleInfo}
LocaleInfoDMA: Locale info for Dominica; see {@see LocaleInfo}
LocaleInfoDNK: Locale info for Denmark; see {@see LocaleInfo}
LocaleInfoDOM: Locale info for Dominican Republic; see {@see LocaleInfo}
LocaleInfoDZA: Locale info for Algeria; see {@see LocaleInfo}
LocaleInfoECU: Locale info for Ecuador; see {@see LocaleInfo}
LocaleInfoEGY: Locale info for Egypt; see {@see LocaleInfo}
LocaleInfoERI: Locale info for Eritrea; see {@see LocaleInfo}
LocaleInfoESP: Locale info for Spain; see {@see LocaleInfo}
LocaleInfoEST: Locale info for Estonia; see {@see LocaleInfo}
LocaleInfoETH: Locale info for Ethiopia; see {@see LocaleInfo}
LocaleInfoEurozone: Locale info for the Eurozone; see {@see LocaleInfo}
LocaleInfoFIN: Locale info for Finland; see {@see LocaleInfo}
LocaleInfoFJI: Locale info for Fiji; see {@see LocaleInfo}
LocaleInfoFRA: Locale info for France; see {@see LocaleInfo}
LocaleInfoFSM: Locale info for Micronesia; see {@see LocaleInfo}
LocaleInfoGAB: Locale info for Gabon; see {@see LocaleInfo}
LocaleInfoGBR: Locale info for United Kingdom; see {@see LocaleInfo}
LocaleInfoGEO: Locale info for Georgia; see {@see LocaleInfo}
LocaleInfoGHA: Locale info for Ghana; see {@see LocaleInfo}
LocaleInfoGIN: Locale info for Guinea; see {@see LocaleInfo}
LocaleInfoGMB: Locale info for Gambia; see {@see LocaleInfo}
LocaleInfoGNB: Locale info for Guinea-Bissau; see {@see LocaleInfo}
LocaleInfoGNQ: Locale info for Equatorial Guinea; see {@see LocaleInfo}
LocaleInfoGRC: Locale info for Greece; see {@see LocaleInfo}
LocaleInfoGRD: Locale info for Grenada; see {@see LocaleInfo}
LocaleInfoGRL: Locale info for Greenland; see {@see LocaleInfo}
LocaleInfoGTM: Locale info for Guatemala; see {@see LocaleInfo}
LocaleInfoGUY: Locale info for Guyana; see {@see LocaleInfo}
LocaleInfoHND: Locale info for Honduras; see {@see LocaleInfo}
LocaleInfoHRV: Locale info for Croatia; see {@see LocaleInfo}
LocaleInfoHTI: Locale info for Haiti; see {@see LocaleInfo}
LocaleInfoHUN: Locale info for Hungary; see {@see LocaleInfo}
LocaleInfoIDN: Locale info for Indonesia; see {@see LocaleInfo}
LocaleInfoIND: Locale info for India; see {@see LocaleInfo}
LocaleInfoIRL: Locale info for Ireland; see {@see LocaleInfo}
LocaleInfoIRN: Locale info for Iran; see {@see LocaleInfo}
LocaleInfoIRQ: Locale info for Iraq; see {@see LocaleInfo}
LocaleInfoISL: Locale info for Iceland; see {@see LocaleInfo}
LocaleInfoISR: Locale info for Israel; see {@see LocaleInfo}
LocaleInfoITA: Locale info for Italy; see {@see LocaleInfo}
LocaleInfoJAM: Locale info for Jamaica; see {@see LocaleInfo}
LocaleInfoJOR: Locale info for Jordan; see {@see LocaleInfo}
LocaleInfoJPN: Locale info for Japan; see {@see LocaleInfo}
LocaleInfoKAZ: Locale info for Kazakhstan; see {@see LocaleInfo}
LocaleInfoKEN: Locale info for Kenya; see {@see LocaleInfo}
LocaleInfoKGZ: Locale info for Kyrgyzstan; see {@see LocaleInfo}
LocaleInfoKHM: Locale info for Cambodia; see {@see LocaleInfo}
LocaleInfoKIR: Locale info for Kiribati; see {@see LocaleInfo}
LocaleInfoKNA: Locale info for Saint Kitts and Nevis; see {@see LocaleInfo}
LocaleInfoKOR: Locale info for South Korea; see {@see LocaleInfo}
LocaleInfoKWT: Locale info for Kuwait; see {@see LocaleInfo}
LocaleInfoLAO: Locale info for Laos; see {@see LocaleInfo}
LocaleInfoLBN: Locale info for Lebanon; see {@see LocaleInfo}
LocaleInfoLBR: Locale info for Liberia; see {@see LocaleInfo}
LocaleInfoLBY: Locale info for Libya; see {@see LocaleInfo}
LocaleInfoLCA: Locale info for Saint Lucia; see {@see LocaleInfo}
LocaleInfoLIE: Locale info for Liechtenstein; see {@see LocaleInfo}
LocaleInfoLKA: Locale info for Sri Lanka; see {@see LocaleInfo}
LocaleInfoLSO: Locale info for Lesotho; see {@see LocaleInfo}
LocaleInfoLTU: Locale info for Lithuania; see {@see LocaleInfo}
LocaleInfoLUX: Locale info for Luxembourg; see {@see LocaleInfo}
LocaleInfoLVA: Locale info for Latvia; see {@see LocaleInfo}
LocaleInfoMAR: Locale info for Morocco; see {@see LocaleInfo}
LocaleInfoMCO: Locale info for Monaco; see {@see LocaleInfo}
LocaleInfoMDA: Locale info for Moldova; see {@see LocaleInfo}
LocaleInfoMDG: Locale info for Madagascar; see {@see LocaleInfo}
LocaleInfoMDV: Locale info for Maldives; see {@see LocaleInfo}
LocaleInfoMEX: Locale info for Mexico; see {@see LocaleInfo}
LocaleInfoMHL: Locale info for Marshall Islands; see {@see LocaleInfo}
LocaleInfoMKD: Locale info for Macedonia; see {@see LocaleInfo}
LocaleInfoMLI: Locale info for Mali; see {@see LocaleInfo}
LocaleInfoMLT: Locale info for Malta; see {@see LocaleInfo}
LocaleInfoMMR: Locale info for Myanmar; see {@see LocaleInfo}
LocaleInfoMNE: Locale info for Montenegro; see {@see LocaleInfo}
LocaleInfoMNG: Locale info for Mongolia; see {@see LocaleInfo}
LocaleInfoMOZ: Locale info for Mozambique; see {@see LocaleInfo}
LocaleInfoMRT: Locale info for Mauritania; see {@see LocaleInfo}
LocaleInfoMUS: Locale info for Mauritius; see {@see LocaleInfo}
LocaleInfoMWI: Locale info for Malawi; see {@see LocaleInfo}
LocaleInfoMYS: Locale info for Malaysia; see {@see LocaleInfo}
LocaleInfoNAM: Locale info for Namibia; see {@see LocaleInfo}
LocaleInfoNER: Locale info for Niger; see {@see LocaleInfo}
LocaleInfoNGA: Locale info for Nigeria; see {@see LocaleInfo}
LocaleInfoNIC: Locale info for Nicaragua; see {@see LocaleInfo}
LocaleInfoNLD: Locale info for Netherlands; see {@see LocaleInfo}
LocaleInfoNOR: Locale info for Norway; see {@see LocaleInfo}
LocaleInfoNPL: Locale info for Nepal; see {@see LocaleInfo}
LocaleInfoNRU: Locale info for Nauru; see {@see LocaleInfo}
LocaleInfoNZL: Locale info for New Zealand; see {@see LocaleInfo}
LocaleInfoOMN: Locale info for Oman; see {@see LocaleInfo}
LocaleInfoPAK: Locale info for Pakistan; see {@see LocaleInfo}
LocaleInfoPAN: Locale info for Panama; see {@see LocaleInfo}
LocaleInfoPER: Locale info for Peru; see {@see LocaleInfo}
LocaleInfoPHL: Locale info for Philippines; see {@see LocaleInfo}
LocaleInfoPLW: Locale info for Palau; see {@see LocaleInfo}
LocaleInfoPNG: Locale info for Papua New Guinea; see {@see LocaleInfo}
LocaleInfoPOL: Locale info for Poland; see {@see LocaleInfo}
LocaleInfoPRK: Locale info for North Korea; see {@see LocaleInfo}
LocaleInfoPRT: Locale info for Portugal; see {@see LocaleInfo}
LocaleInfoPRY: Locale info for Paraguay; see {@see LocaleInfo}
LocaleInfoPSE: Locale info for Palestine; see {@see LocaleInfo}
LocaleInfoQAT: Locale info for Qatar; see {@see LocaleInfo}
LocaleInfoROU: Locale info for Romania; see {@see LocaleInfo}
LocaleInfoRUS: Locale info for Russian Federation; see {@see LocaleInfo}
LocaleInfoRWA: Locale info for Rwanda; see {@see LocaleInfo}
LocaleInfoSAU: Locale info for Saudi Arabia; see {@see LocaleInfo}
LocaleInfoSDN: Locale info for Sudan; see {@see LocaleInfo}
LocaleInfoSEN: Locale info for Senegal; see {@see LocaleInfo}
LocaleInfoSGP: Locale info for Singapore; see {@see LocaleInfo}
LocaleInfoSHN: Locale info for Saint Helena; see {@see LocaleInfo}
LocaleInfoSLB: Locale info for Solomon Islands; see {@see LocaleInfo}
LocaleInfoSLE: Locale info for Sierra Leone; see {@see LocaleInfo}
LocaleInfoSLV: Locale info for El Salvador; see {@see LocaleInfo}
LocaleInfoSMR: Locale info for San Marino; see {@see LocaleInfo}
LocaleInfoSOM: Locale info for Somalia; see {@see LocaleInfo}
LocaleInfoSRB: Locale info for Serbia; see {@see LocaleInfo}
LocaleInfoSSD: Locale info for South Sudan; see {@see LocaleInfo}
LocaleInfoSTP: Locale info for Sao Tome and Principe; see {@see LocaleInfo}
LocaleInfoSUR: Locale info for Suriname; see {@see LocaleInfo}
LocaleInfoSVK: Locale info for Slovakia; see {@see LocaleInfo}
LocaleInfoSVN: Locale info for Slovenia; see {@see LocaleInfo}
LocaleInfoSWE: Locale info for Sweden; see {@see LocaleInfo}
LocaleInfoSWZ: Locale info for Swaziland; see {@see LocaleInfo}
LocaleInfoSYC: Locale info for Seychelles; see {@see LocaleInfo}
LocaleInfoSYR: Locale info for Syrian Arab Republic; see {@see LocaleInfo}
LocaleInfoTCD: Locale info for Chad; see {@see LocaleInfo}
LocaleInfoTGO: Locale info for Togo; see {@see LocaleInfo}
LocaleInfoTHA: Locale info for Thailand; see {@see LocaleInfo}
LocaleInfoTJK: Locale info for Tajikistan; see {@see LocaleInfo}
LocaleInfoTKM: Locale info for Turkmenistan; see {@see LocaleInfo}
LocaleInfoTLS: Locale info for Timor-Leste; see {@see LocaleInfo}
LocaleInfoTON: Locale info for Tonga; see {@see LocaleInfo}
LocaleInfoTTO: Locale info for Trinidad and Tobago; see {@see LocaleInfo}
LocaleInfoTUN: Locale info for Tunisia; see {@see LocaleInfo}
LocaleInfoTUR: Locale info for Turkey; see {@see LocaleInfo}
LocaleInfoTUV: Locale info for Tuvalu; see {@see LocaleInfo}
LocaleInfoTWN: Locale info for Taiwan; see {@see LocaleInfo}
LocaleInfoTZA: Locale info for Tanzania; see {@see LocaleInfo}
LocaleInfoUGA: Locale info for Uganda; see {@see LocaleInfo}
LocaleInfoUKR: Locale info for Ukraine; see {@see LocaleInfo}
LocaleInfoUMI: Locale info for United States Minor Outlying Islands; see {@see LocaleInfo}
LocaleInfoURY: Locale info for Uruguay; see {@see LocaleInfo}
LocaleInfoUSA: Locale info for USA; see {@see LocaleInfo}
LocaleInfoUZB: Locale info for Uzbekistan; see {@see LocaleInfo}
LocaleInfoVAT: Locale info for Vatican City; see {@see LocaleInfo}
LocaleInfoVCT: Locale info for Saint Vincent and the Grenadines; see {@see LocaleInfo}
LocaleInfoVEN: Locale info for Venezuela; see {@see LocaleInfo}
LocaleInfoVNM: Locale info for Viet Nam; see {@see LocaleInfo}
LocaleInfoVUT: Locale info for Vanuatu; see {@see LocaleInfo}
LocaleInfoWSM: Locale info for Samoa; see {@see LocaleInfo}
LocaleInfoYEM: Locale info for Yemen; see {@see LocaleInfo}
LocaleInfoZAF: Locale info for South Africa; see {@see LocaleInfo}
LocaleInfoZMB: Locale info for Zambia; see {@see LocaleInfo}
LocaleInfoZWE: Locale info for Zimbabwe; see {@see LocaleInfo}
Markdown: Markdown helper.
Media: Helpers for resolving and loading media files.
Module: Base module class.
Modules: Manage module registrations.
MultiEdit: UI system for rapid adding/editing of any number of (sub-)records
Mutex: Mutex helper.
Navigation: Provides navigation functions
NavigationGroups: Menu groups for front end main navigation
NavigationMenu: Renders a menu for the page node structure
Needs: Provides a system for injecting CSS and Javascript includes into the head of a document even after the head has been outputted.
Encoder: Converts value to NEON format.
Neon: Simple parser & generator for Nette Object Notation.
Notification: Provides user event notification functions
Page: Methods for working with CMS pages
Pagenode: Represents a page in a page tree
PageRouting: Logic for selecting the page if no controller matches
Pdb: Class for doing database queries via PDO (PDO Database => Pdb)
PerRecordPerms: Helper for implementing per-record permissions
Phones: Helpers for common phone number functions
PhpView: Loads and displays Kohana view files.
Preview: Somewhat complicated preview system which copies existing data into temporary tables, then renders the preview via a front-end method call
Profiling: Performance profiling.
QualityImageTransform: Sets the image quality for JPEGs.
QueryTo: No description yet.
RateLimit: Rate-limiting system, to prefent people form doing hacky stuff
Rdb: Redis wrapper + utilities.
Recaptcha: Implementation of Google (No CAPTCHA) ReCAPTCHA
Recaptcha3
RefineBar: Provides the search refinement options in the admin UI
RefineWidget: Base class for widgets included in a {@see RefineBar}
RefineWidgetAutocomplete: An autocomplete widget for the refine bar
RefineWidgetDatepicker: A datepicker widget for the refine bar
RefineWidgetSelect: A textbox widget
RefineWidgetTextbox: A textbox widget
Register: This will one day have methods for various different aspects of the cms incl. widgets, search handlers, tabs, etc.
Replication: Functions for database replication.
Request: Get information about the incoming HTTP request.
ResizeImageTransform: Does image resizing, etc
RichText: Interface the display of a richtext field
RichTextSanitiser: Helper that strictly validates and sanitises user submitted HTML Intended for use with front-end instances of TinyMCE to ensure XSS is impossible.
Router: Router
Rs: Functions to hack database query result sets
RssFeed
RteLibContainer: Returned by RteLibrary classes to represent a "container" (e.g. directories) in the browse structure
RteLibObject: Returned by RteLibrary classes to represent a "object" (e.g. files) in the browse structure
RteLibrary
RteLibraryDocuments: Richtext library for media repository documents
RteLibraryHasCategories: Abstract richtext library for bog-standard "has categories" modules, such as news articles, blog posts, etc.
RteLibraryImages: Richtext library for media repository sounds, they launch in a popup audio player
RteLibraryPages: Richtext library for pages
RteLibrarySounds: Richtext library for media repository sounds, they launch in a popup audio player
Search: Functions for front-end search indexing
SearchHandler: Defines a table which can be searched against using the front-end search
Security: Functions for implementing security, including secure random numbers
Services: External services helper.
Session: Session library.
SessionStats
SitemapGen
SitemapGenPages
SiteSettings
Skin: Skin stuff - autoversioning mainly.
Slug: Generate and validate slugs - i.e. unique, SEO-friendly URL segments.
SocialMeta: Management of social meta data tags, such as Facebook OpenGraph and Twitter Cards
SocialNetworking: Has methods for outputting links for submitting to a number of social networking sites
SortedColModifier: Extend this instead of ColModifier, if your output sort order matches the database sort order.
Spam: Helper for a simple mechanism to dissuade and annoy entry-level spammers.
Sprout: Useful functions for sprout in general
SproutExtension: This is a set of extension functions/filters for Twig templates.
SproutVariable: Access to Sprout helpers from Twig templates.
Ssl: Used to force an SSL (i.e. HTTPS) connection for configured controllers and methods.
Subscribe: Base class for the content subscription handlers
Subsites: Provides functions for getting information about subsites
SubsiteSelector
Tags: No description yet.
Text: Various text helpers such as limiting.
TextareaRichText: Interface the display of a richtext field
TinyMCE4RichText: Interface the display of a richtext field
Treenode: Represents a node in the tree
TreenodeContainsMatcher: Matches a node which has a specific key containing a specific value
TreenodeFrontendMatcher: Matches a node which has a specific key matching a specific value
TreenodeHasWidgetMatcher: Matches a node which has a specific key matching a specific value
TreenodeIdsMatcher: Matches a node which which has an id of one of the ids in the list
TreenodeInMenuMatcher: Matches a node which has a specific key matching a specific value
TreenodePageAttrMatcher: Matches a node which has a specific key matching a specific value
TreenodePathMatcher: Matches a node which has a specified path.
TreenodeRedirectMatcher: Matches a node which has a specific key matching a specific value
TreenodeRegexMatcher: Matches a node which has a specific key containing a specific value
TreenodeValueMatcher: Matches a node which has a specific key matching a specific value
TwigSkinLoader: File loader for twig templates.
TwigView: Renderer for twig engine
FixedBitNotation: The FixedBitNotation class is for binary to text conversion. It can handle many encoding schemes, formally defined or not, that use a fixed number of bits to encode each character.
GoogleAuthenticator
UnescapedColModifier: Extend this instead of ColModifier, if your output SHOULD NOT be escaped, i.e. it is already HTML
Upload: Upload helper class for working with the global $_FILES array and Validation library.
Url: Helper functions for working with URLs.
UserAgent: Implementation of parser for user-agents.json file
UserAuth: A default implementation of user auth when the users module is not installed.
UserPerms: Default implementation of user permissions for when the users module is not installed.
Utf8: UTF-8 helper class.
Validator: Used with the {@see Validity} class.
Validity: All of its methods should give useful errors by throwing a {@see ValidationException}.
View: Loads and displays Kohana view files.
WidgetArea: Stores information about an individual widget area, including the names of all widgets that are allowed to be in this area.
Widgets: Provided functions for the display of widgets
Worker: Functions called by worker libraries to indicate status, etc
WorkerBase: Base class for worker jobs, which are run via CLI in a separate process
WorkerCtrl: Functions to update and report on worker status
WorkerFileDefaultTransforms: Base class for worker jobs, which are run via CLI in a separate process
WorkerFilesBackendMigrate: Base class for worker jobs, which are run via CLI in a separate process
WorkerJob: Base class for worker jobs.
WorkerLinkChecker: Base class for worker jobs, which are run via CLI in a separate process
WorkerQueue: A queue of worker jobs.
WorkerRedoSizes: Base class for worker jobs, which are run via CLI in a separate process
CategoryModel: A collection is a defined model for an object.
DocumentTypeModel: Base model class
ExtraPageModel: Base model class
FileModel: Base model class
FileTransformModel: Base model class
MenuExtraModel: Base model class
MenuGroupModel: Base model class
OperatorModel: Base model class
PageAtrributesModel: Base model class
PageHistoryItemModel: Base model class
PageModel: Base model class
PageRevisionModel: Base model class
PageWidgetModel: Base model class
SproutAiApiRequest: Base model class
SubsiteModel: Base model class
SproutVisor: A Visor server for Sprout.
WelcomeController: Forms used for setting up SproutCMS for the first time
WelcomeModule: The welcome module.
AdvancedSearchFormWidget: Shows a box for searching documents
AudioWidget: Basically just a test widget
ChildrenGalleryWidget: Shows a list of pages that are related to this one
ChildrenPagesWidget: Shows a list of pages that are related to this one
FileListWidget: doc list widget
HelloWorldWidget: Basically just a test widget
HtmlCodeWidget: Spits out HTML code
ImageGalleryWidget: Shows a list of pages that are related to this one
MapDirectionsWidget: Displays a google map
MapWidget: Displays a google map
PageColumnsWidget: Base class for widgets
RelatedLinksWidget: Shows a list of pages that are related to this one
RichTextWidget: Spits out HTML code
RssFeedWidget: Spits out HTML code
SitemapWidget: Shows a site map
VideoPlaylistWidget: Renders a gallery of videos
VideoWidget: Basically just a test widget
Widget: Base class for widgets

Traits

ArrayableTrait: Adds a `toArray()` method that returns an array copy of this object.
ArrayAccessTrait
SerializeTrait: Implements a PHP serialiser.
ToJsonTrait: JSON builders for models.
VirtualArrayTrait
VirtualMethodsTrait
RdbHelperTrait
AiLoggingTrait
ModuleSiteTrait
OpenAiClientTrait: Allows for hot-swapping of other providers into the OpenAi ecosystem
FileTrait: Common fields and tooling for file caching and backend info

Constants

APPPATH : mixed = \COREPATH . 'sprout' . \DIRECTORY_SEPARATOR
COREPATH : mixed = __DIR__ . \DIRECTORY_SEPARATOR
DOCROOT : mixed = \BASE_PATH . 'src' . \DIRECTORY_SEPARATOR
E_DATABASE_ERROR : mixed = 44
E_KOHANA : mixed = 42
E_PAGE_NOT_FOUND : mixed = 43
ENVIRONMENT : mixed = \getenv('SITES_ENVIRONMENT') ?: 'dev'
IN_PRODUCTION : mixed = \ENVIRONMENT === 'prod'
KOHANA : mixed = 'index.php'
PHPUNIT : mixed = 0
SERVER_ONLINE : mixed = \true
SITES_ENVIRONMENT : mixed = \ENVIRONMENT
SPROUT_REQUEST_TAG : mixed = Uuid::uuid4()
SPROUT_REQUEST_TIME : mixed = microtime(TRUE)
STORAGE_PATH : mixed = \BASE_PATH . 'storage' . \DIRECTORY_SEPARATOR
VENDOR_PATH : mixed = \BASE_PATH . 'vendor' . \DIRECTORY_SEPARATOR
WEBROOT : mixed = \BASE_PATH . 'web' . \DIRECTORY_SEPARATOR
WORKER_PHP_BIN : mixed = \getenv('SITES_PHP_BIN')

Functions

arrayMapRecursive() : mixed: Recursive version of array_map function I would imagine would be much slower than the original. Only use if necessary

APPPATH


    public
        mixed
    APPPATH
    = \COREPATH . 'sprout' . \DIRECTORY_SEPARATOR

COREPATH


    public
        mixed
    COREPATH
    = __DIR__ . \DIRECTORY_SEPARATOR

DOCROOT


    public
        mixed
    DOCROOT
    = \BASE_PATH . 'src' . \DIRECTORY_SEPARATOR

E_DATABASE_ERROR


    public
        mixed
    E_DATABASE_ERROR
    = 44

E_KOHANA


    public
        mixed
    E_KOHANA
    = 42

E_PAGE_NOT_FOUND


    public
        mixed
    E_PAGE_NOT_FOUND
    = 43

ENVIRONMENT


    public
        mixed
    ENVIRONMENT
    = \getenv('SITES_ENVIRONMENT') ?: 'dev'

IN_PRODUCTION


    public
        mixed
    IN_PRODUCTION
    = \ENVIRONMENT === 'prod'

KOHANA


    public
        mixed
    KOHANA
    = 'index.php'

PHPUNIT


    public
        mixed
    PHPUNIT
    = 0

SERVER_ONLINE


    public
        mixed
    SERVER_ONLINE
    = \true

SITES_ENVIRONMENT

use ENVIRONMENT


    public
        mixed
    SITES_ENVIRONMENT
    = \ENVIRONMENT

SPROUT_REQUEST_TAG


    public
        mixed
    SPROUT_REQUEST_TAG
    = Uuid::uuid4()

SPROUT_REQUEST_TIME


    public
        mixed
    SPROUT_REQUEST_TIME
    = microtime(TRUE)

STORAGE_PATH


    public
        mixed
    STORAGE_PATH
    = \BASE_PATH . 'storage' . \DIRECTORY_SEPARATOR

VENDOR_PATH


    public
        mixed
    VENDOR_PATH
    = \BASE_PATH . 'vendor' . \DIRECTORY_SEPARATOR

WEBROOT


    public
        mixed
    WEBROOT
    = \BASE_PATH . 'web' . \DIRECTORY_SEPARATOR

WORKER_PHP_BIN


    public
        mixed
    WORKER_PHP_BIN
    = \getenv('SITES_PHP_BIN')

arrayMapRecursive()

Recursive version of array_map function I would imagine would be much slower than the original. Only use if necessary


    
                    arrayMapRecursive(mixed $callback, array<string|int, mixed> $array) : mixed

Parameters

$callback : mixed: Callback function, can be string, array or in PHP 5.3, a function
$array : array<string|int, mixed>: The array to process

Documentation

Application

Table of Contents

Interfaces

Classes

Traits

Constants

Functions

Constants

APPPATH

COREPATH

DOCROOT

E_DATABASE_ERROR

E_KOHANA

E_PAGE_NOT_FOUND

ENVIRONMENT

IN_PRODUCTION

KOHANA

PHPUNIT

SERVER_ONLINE

SITES_ENVIRONMENT

SPROUT_REQUEST_TAG

SPROUT_REQUEST_TIME

STORAGE_PATH

VENDOR_PATH

WEBROOT

WORKER_PHP_BIN

Functions

arrayMapRecursive()

Parameters

Search results