Helpers
Table of Contents
Namespaces
- AI
- Aws
- DisplayConditions
- DocImport
- Drivers
- Locales
- Neon
- Rules
- TwoFactor
Interfaces
- ExportDBMS
- 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
- 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
- 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
- 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
- CliServer
- Bridge the CLI-server environment with Kohana/Sprout.
- 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
- ColModifierJsonArray
- Helper for rendering out array data from a json stored string
- 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
- 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
- ExportDBMS_MySQL
- Exporter for MySQL databases.
- ExportDBMS_SQLite
- Exporter for SQLite databases.
- 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}
- LinkSpecImage
- Like LinkSpecDocument but specialised for images with resizing.
- 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.
- Markdown
- Markdown helper.
- Media
- Helpers for resolving and loading media files.
- Model
- Base model class
- ModelQuery
- Base model query
- Moderate
- A base class for moderation.
- 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.
- 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
- Record
- This is a lightweight model.
- 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
- 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.
- WebCrawler
- Tools for crawling/scraping web pages
- 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
Traits
- AiLoggingTrait
- ModuleSiteTrait
- OpenAiClientTrait
- Allows for hot-swapping of other providers into the OpenAi ecosystem