Index | Chappy.php API

A

React::authComponents() — Method in class React: Generates the auth jsx components.
ReactStubs::authLogin() — Method in class ReactStubs: Sub for auth/Login.jsx page component.
ReactStubs::authRegister() — Method in class ReactStubs: Stub for auth/Register.jsx page component.
Test::allTests() — Method in class Test: Performs all tests.
Application — Class in namespace Core: The Application class supports basic functional needs of the application.
APIException — Class in namespace Core\Exceptions\API: Handles exceptions related to APIs.
FormHelper::appendErrorClass() — Method in class FormHelper: Adds name of error classes to div associated with a form field.
Blueprint::after() — Method in class Blueprint: Specifies the position of the last defined column to appear immediately after another column in the table (MySQL only).
Migration::aclSetup() — Method in class Migration: Setup acl table's initial fields during first db migration.
AccountDeactivated — Class in namespace Core\Lib\Events: Simple DTO (Data Transfer Object) class for password reset event.
Uploads::addErrorMessage() — Method in class Uploads: Adds an error message to the $_errors array.
Api — Class in namespace Core\Lib\Http: Lightweight HTTP JSON client with optional on-disk caching.
JsonResponse::apiCsrfCheck() — Method in class JsonResponse: Checks if CSRF token has been tampered with.
AbstractMailer — Class in namespace Core\Lib\Mail: Describes specification for all mailers.
AccountDeactivatedMailer — Class in namespace Core\Lib\Mail: Class for generating a message informing the user that their password has been updated.
Attachments — Class in namespace Core\Lib\Mail: Supports attachment processing for MailerService.
Attachments::attach() — Method in class Attachments: Processes attachment if key labeled content is found.
Attachments::attachFromPath() — Method in class Attachments: Processes attachment if key labeled path is found.
ChannelRegistry::all() — Method in class ChannelRegistry: Return array of channel classes.
ApplicationTestCase — Class in namespace Core\Lib\Testing: Abstract class for test cases.
ApplicationTestCase::assertDatabaseHas() — Method in class ApplicationTestCase: Assert that a record exists in the specified database table with the given conditions.
ApplicationTestCase::assertDatabaseMissing() — Method in class ApplicationTestCase: Assert that no record exists in the specified database table with the given conditions.
ApplicationTestCase::assertViewContains() — Method in class ApplicationTestCase: Asserts that a property exists on the View object captured via controllerOutput().
TestResponse::assertDontSee() — Method in class TestResponse: Asserts that the given text is not present in the response content.
TestResponse::assertJson() — Method in class TestResponse: Asserts that the response content is a valid JSON string and that it contains the specified keys and values.
TestResponse::assertSee() — Method in class TestResponse: Asserts that the response content contains the given text.
TestResponse::assertStatus() — Method in class TestResponse: Asserts that the response status matches the expected value.
Arr — Class in namespace Core\Lib\Utilities: Contains functions that support array operations.
Arr::add() — Method in class Arr: Add a value to an array if the key does not exist.
Arr::arrayDivide() — Method in class Arr: Split an array into two separate arrays: one with keys, one with values.
Arr::arrayPluckMulti() — Method in class Arr: Pluck a nested value from an array.
Arr::arrayShuffleAssoc() — Method in class Arr: Shuffle an associative array while preserving keys.
ArraySet — Class in namespace Core\Lib\Utilities: Array utility class with functions for both chainable operations.
ArraySet::add() — Method in class ArraySet: Add a value to the array if the key does not exist.
ArraySet::all() — Method in class ArraySet: Get all items in the array.
ArraySet::asort() — Method in class ArraySet: Sort the array while maintaining index association.
ArraySet::arsort() — Method in class ArraySet: Sort the array in descending order while maintaining index association.
Str::after() — Method in class Str: Get the portion of a string after the first occurrence of a given value.
Str::ascii() — Method in class Str: Convert a string to its ASCII representation.
Model::addErrorMessage() — Method in class Model: Generates error messages that occur during form validation.
Model::afterDelete() — Method in class Model: Called before delete.
Model::afterSave() — Method in class Model: Called before save.
Model::assign() — Method in class Model: Update the object with an associative array.
ACL — Class in namespace Core\Models: Describes ACL model.
$ ACL#acl — Property in class ACL: The acl value.
$ EmailAttachments#allowedFileTypes — Property in class EmailAttachments: The array of allowed types.
$ EmailAttachments#attachment_name — Property in class EmailAttachments: The attachment's name.
$ ProfileImages#allowedFileTypes — Property in class ProfileImages: The allowed file types.
$ Queue#attempts — Property in class Queue: Number of attempts.
$ Queue#available_at — Property in class Queue: Available at.
ACLService — Class in namespace Core\Services: Collection of functions for managing User's ACLs.
ACLService::aclsForUser() — Method in class ACLService: Returns an array containing access control list information. When the $acl instance variable is empty an empty array is returned.
ACLService::aclToArray() — Method in class ACLService: Ensures that we are always dealing with an array of ACLs
ACLService::addAcl() — Method in class ACLService: Add ACL to user's acl field as an element of an array.
AttachmentService — Class in namespace Core\Services: Service for managing attachment uploads and deletion.
AttachmentService::attachmentUpload() — Method in class AttachmentService: Generates upload object for attachments.
AttachmentService::attachmentUploader() — Method in class AttachmentService: Retrieves user who uploaded an attachment.
AuthService — Class in namespace Core\Services: Supports authentication operations.
Session::addMessage() — Method in class Session: Adds a session alert message.
$ CustomValidator#additionalFieldData — Property in class CustomValidator: Additional field data.
View::addWidget() — Method in class View: Registers a new widget.

B

Migrate::batchExists() — Method in class Migrate: Test if a particular batch of migrations exists.
$ MigrationStatus#batch — Property in class MigrationStatus: The batch value for a particular migration.
Notifications::buildPayload() — Method in class Notifications: Build the per-send payload for the test command.
Tools::border() — Method in class Tools: Returns dashed border.
RestrictedController::badTokenAction() — Method in class RestrictedController: Renders page when a bad csrf token is detected.
DB::beginTransaction() — Method in class DB: Begins a database transaction.
FormHelper::button() — Method in class FormHelper: Supports ability to create a styled button. Supports ability to have functions for event handlers.
FormHelper::buttonBlock() — Method in class FormHelper: Supports ability to create a styled button and styled surrounding div block. Supports ability to have functions for event handlers".
Helper::buildMenuListItems() — Method in class Helper: Creates list of menu items.
Blueprint — Class in namespace Core\Lib\Database: Handles schema definitions before executing them.
Blueprint::bigInteger() — Method in class Blueprint: Define a big integer column.
Blueprint::boolean() — Method in class Blueprint: Define a boolean column.
QueuePreferences::backoff() — Method in class QueuePreferences: Get the backoff time(s) between retry attempts.
EventManager::boot() — Method in class EventManager: Boots event service upon application start.
$ Api#baseUrl — Property in class Api: Base URL (no trailing slash), e.g. "https://api.example.com/v1"
Api::buildUrl() — Method in class Api: Build an absolute URL with merged default + per-call query parameters.
AbstractMailer::buildAndSend() — Method in class AbstractMailer: Common send logic shared by all mailers.
NotificationManager::boot() — Method in class NotificationManager: Boots notification service on application start.
EventServiceProvider::boot() — Method in class EventServiceProvider: Boot any services after registration. Can be overridden.
NotificationServiceProvider::bootNotifications() — Method in class NotificationServiceProvider: Register channels for notifications.
ServiceProvider::boot() — Method in class ServiceProvider: Boot any services after registration. Can be overridden.
$ QueuedListenerJob#backoff — Property in class QueuedListenerJob: Backoff delay(s) used between retry attempts.
QueuedListenerJob::backoff() — Method in class QueuedListenerJob: Sets backoff for a job
QueueableJobInterface::backoff() — Method in class QueueableJobInterface: Sets backoff for a job
Str::base64Encode() — Method in class Str: Base64 encode a string.
Str::base64Decode() — Method in class Str: Base64 decode a string.
Str::before() — Method in class Str: Get the portion of a string before the first occurrence of a given value.
Str::between() — Method in class Str: Get the substring between two given substrings.
Model::beforeDelete() — Method in class Model: This runs before delete, needs to return a boolean
Model::beforeSave() — Method in class Model: Called after save.
ACL::beforeSave() — Method in class ACL: Implements beforeSave function described in Model parent class.
EmailAttachments::beforeSave() — Method in class EmailAttachments: Implementation of beforeSave function where timestamps are updated.
Notifications::beforeSave() — Method in class Notifications: Called after save.
ProfileImages::beforeSave() — Method in class ProfileImages: Called after save.
Queue::beforeSave() — Method in class Queue: Called after save.
UserSessions::beforeSave() — Method in class UserSessions: Called after save.

C

DropTablesCommand::configure() — Method in class DropTablesCommand: Configures the command.
GenerateControllerCommand::configure() — Method in class GenerateControllerCommand: Configures the command.
GenerateMigrationCommand::configure() — Method in class GenerateMigrationCommand: Configures the command.
GenerateModelCommand::configure() — Method in class GenerateModelCommand: Configures the command.
MakeAclCommand::configure() — Method in class MakeAclCommand: Configures the command.
MakeCSSCommand::configure() — Method in class MakeCSSCommand: Configures the command.
MakeCommand::configure() — Method in class MakeCommand: Configures the command.
MakeComponentCommand::configure() — Method in class MakeComponentCommand: Configures the command.
MakeEmailCommand::configure() — Method in class MakeEmailCommand: Configures the command.
MakeEmailLayoutCommand::configure() — Method in class MakeEmailLayoutCommand: Configures the command.
MakeEventCommand::configure() — Method in class MakeEventCommand: Configures the command.
MakeEventServiceProviderCommand::configure() — Method in class MakeEventServiceProviderCommand: Configures the command.
MakeHelperCommand::configure() — Method in class MakeHelperCommand: Configures the command.
MakeJobCommand::configure() — Method in class MakeJobCommand: Configures the command.
MakeLayoutCommand::configure() — Method in class MakeLayoutCommand: Configures the command.
MakeListenerCommand::configure() — Method in class MakeListenerCommand: Configures the command.
MakeMailerCommand::configure() — Method in class MakeMailerCommand: Configures the command.
MakeMenuCommand::configure() — Method in class MakeMenuCommand: Configures the command.
MakeNotificationCommand::configure() — Method in class MakeNotificationCommand: Configures the command.
MakeReactComponentCommand::configure() — Method in class MakeReactComponentCommand: Configures the command.
MakeReactPageCommand::configure() — Method in class MakeReactPageCommand: Configures the command.
MakeReactUtilCommand::configure() — Method in class MakeReactUtilCommand: Configures the command.
MakeSeederCommand::configure() — Method in class MakeSeederCommand: Configures the command.
MakeServiceCommand::configure() — Method in class MakeServiceCommand: Configures the command.
MakeTestCommand::configure() — Method in class MakeTestCommand: Configures the command.
MakeValidatorCommand::configure() — Method in class MakeValidatorCommand: Configures the command
MakeViewCommand::configure() — Method in class MakeViewCommand: Configures the command.
MakeWidgetCommand::configure() — Method in class MakeWidgetCommand: Configures the command.
MigrateFreshCommand::configure() — Method in class MigrateFreshCommand: Configures the command.
MigrateRefreshCommand::configure() — Method in class MigrateRefreshCommand: Configures the command.
MigrateRollbackCommand::configure() — Method in class MigrateRollbackCommand: Configures the command.
MigrateStatusCommand::configure() — Method in class MigrateStatusCommand: Configures the command.
NotificationTestCommand::configure() — Method in class NotificationTestCommand: Configures the command.
NotificationsMigrationCommand::configure() — Method in class NotificationsMigrationCommand: Configures the command.
NotificationsPruneCommand::configure() — Method in class NotificationsPruneCommand: Configures the command.
QueueMigrationCommand::configure() — Method in class QueueMigrationCommand: Configures the command.
QueueWorkerCommand::configure() — Method in class QueueWorkerCommand: Configures the command.
ReactAuthCommand::configure() — Method in class ReactAuthCommand: Configures the command.
ReactErrorCommand::configure() — Method in class ReactErrorCommand: Configures the command.
ReactHomeCommand::configure() — Method in class ReactHomeCommand: Configures the command.
ReactProfileCommand::configure() — Method in class ReactProfileCommand: Configures the command.
RemoveLogsCommand::configure() — Method in class RemoveLogsCommand: Configures the command.
RemoveProfileImagesCommand::configure() — Method in class RemoveProfileImagesCommand: Configures the command.
RunMigrationCommand::configure() — Method in class RunMigrationCommand: Configures the command.
RunTestCommand::configure() — Method in class RunTestCommand: Configures the command.
SeedCommand::configure() — Method in class SeedCommand: Configures the command.
ServeCommand::configure() — Method in class ServeCommand: Configures the command.
ServeDocsCommand::configure() — Method in class ServeDocsCommand: Configures the command.
ServeUserGuideCommand::configure() — Method in class ServeUserGuideCommand: Configures the command.
TinkerCommand::configure() — Method in class TinkerCommand: Configures the command.
CommandHelper — Class in namespace Console\Helpers: Supports commands related to building console commands and associated helper classes.
CommandHelper::commandTemplate() — Method in class CommandHelper: Creates template for new command class.
Controller — Class in namespace Console\Helpers: Helper class for controller related console commands.
Notifications::channelOptions() — Method in class Notifications: Resolve the --channels option into a normalized list of channels.
Tools::createDirWithPrompt() — Method in class Tools: Creates a directory. It checks if it already exists. If not, user is asked to confirm the want to create a new directory.
View::cardComponent() — Method in class View: Returns contents of a card component.
Controller — Class in namespace Core: This is the parent Controller class. It describes functions that are available to all classes that extends this Controller class.
Cookie — Class in namespace Core: Manages cookies used by this application. The $_COOKIE superglobal variable is an associative array.
DB::commit() — Method in class DB: Commits the current database transaction.
DB::connect() — Method in class DB: Establishes a new database connection using the provided configuration array.
DB::count() — Method in class DB: Getter function for the private _count variable.
ConsoleException — Class in namespace Core\Exceptions\Console: Handles exceptions related to the console.
ChannelException — Class in namespace Core\Exceptions\Notifications: Handles exceptions related to channels. Extends the NotificationException class.
ChannelSendFailedException — Class in namespace Core\Exceptions\Notifications: Handles exceptions related to sending through a channel. Extends the ChannelException class
ComponentNotFoundException — Class in namespace Core\Exceptions\View: Class to handle events related to components not being found.
FormHelper::checkboxBlockLabelLeft() — Method in class FormHelper: Generates a div containing an input of type checkbox with the label to the left.
FormHelper::checkboxBlockLabelRight() — Method in class FormHelper: Generates a div containing an input of type checkbox with the label to the right.
FormHelper::checkToken() — Method in class FormHelper: Checks if the csrf token exists. This is used to verify that there has been no tampering of a form's csrf token.
FormHelper::csrfInput() — Method in class FormHelper: A hidden input to represent the csrf token in a web form.
Helper::currentPage() — Method in class Helper: Determines current page based on REQUEST_URI.
Input::csrfCheck() — Method in class Input: Checks csrf token to determine if it was tampered with. If the check fails the user is routed to a view stating access is restricted.
Blueprint::create() — Method in class Blueprint: Create the table.
Schema::create() — Method in class Schema: Create a new table.
$ Api#cacheDir — Property in class Api: Absolute path to the cache directory for this client/namespace.
Api::cacheFile() — Method in class Api: Compute the cache filename for a given URL.
Attachments::content() — Method in class Attachments: Used to assemble array for attachment when content key is used.
ChannelRegistry — Class in namespace Core\Lib\Notifications: Registry for notification channel drivers.
LogChannel::configureLog() — Method in class LogChannel: Configures log array
LogChannel::controlKeys() — Method in class LogChannel: Return the list of control keys that will be stripped from the data bag.
Channel — Class in namespace Core\Lib\Notifications\Contracts: Contract for delivering notifications over a specific transport (database, mail, SMS, etc).
Notification::channels() — Method in class Notification: Get an array of available channels.
Notification::channelValues() — Method in class Notification: Returns list of all channels as an array of strings.
Pagination::currentPage() — Method in class Pagination: Retrieves current page from GET request.
Vite::csrfToken() — Method in class Vite: Extracts value of csrf_token from hidden element.
$ ApplicationTestCase#controllerOutput — Property in class ApplicationTestCase: The controller output.
ApplicationTestCase::controllerOutput() — Method in class ApplicationTestCase: Simulates a controller action based on URL-style input and captures its output.
Arr::collapse() — Method in class Arr: Collapse a multi-dimensional array into a single-level array.
Arr::chunk() — Method in class Arr: Split an array into chunks of a given size.
Arr::chunkBy() — Method in class Arr: Chunk an array into groups based on a callback function.
Arr::contains() — Method in class Arr: Determine if a given value exists in an array.
Arr::crossJoin() — Method in class Arr: Compute the Cartesian product of multiple arrays.
ArraySet::chunk() — Method in class ArraySet: Split an array into chunks.
ArraySet::clear() — Method in class ArraySet: Clear all items in the array.
ArraySet::collapse() — Method in class ArraySet: Collapse a multi-dimensional array into a single level.
ArraySet::column() — Method in class ArraySet: Extract a single column from a multi-dimensional array.
ArraySet::combine() — Method in class ArraySet: Combine two arrays, one as keys and one as values.
ArraySet::contains() — Method in class ArraySet: Check if an array contains a specific value.
ArraySet::crossJoin() — Method in class ArraySet: Compute the Cartesian product of multiple arrays.
ArraySet::count() — Method in class ArraySet: Get the count of elements in the array.
Config — Class in namespace Core\Lib\Utilities: Manages the usage of configuration files.
$ Config#configs — Property in class Config
Str::camel() — Method in class Str: Convert a string to camelCase.
Str::chunk() — Method in class Str: Split a string into chunks.
Str::compare() — Method in class Str: Compare two strings.
Str::contains() — Method in class Str: Determine if a string contains a given substring.
Str::crc32() — Method in class Str: Calculate CRC32 hash of a string.
$ EmailAttachments#created_at — Property in class EmailAttachments: Create at.
$ Notifications#created_at — Property in class Notifications: Created at.
$ Queue#created_at — Property in class Queue: Created at.
Queue::calcRetryDelay() — Method in class Queue: Calculate delay when performing retry for a job.
ACLService::checkACL() — Method in class ACLService: Checks if ACL is found and sets flash message if not the case. Also, checks if it is assigned to a user and sets flash message.
AuthService::confirm() — Method in class AuthService: Gets value of password confirm field. Assumes field value is "confirm".
AuthService::currentUser() — Method in class AuthService: Checks if a user is logged in.
DashboardService::checkIfCurrentUser() — Method in class DashboardService: Warns if admin user is attempting to view an area they should not be.
$ HasTimestamps#created_at — Property in class HasTimestamps: Time record was created.
CustomValidator — Class in namespace Core\Validators: Abstract parent class for our child validation child classes. Each child class must implement the runValidation() function.
View::component() — Method in class View: Includes a component into a view.
View::content() — Method in class View: The content of the page. The two types are head and body. If necessary, we can implement additional types of content.

D

DropTablesCommand — Class in namespace Console\Commands: Supports ability to drop all tables by using the migrate:drop-all command.
Controller::defaultTemplate() — Method in class Controller: The default template for a new controller.
DBSeeder — Class in namespace Console\Helpers: Supports operations related to database seeding.
Log::delete() — Method in class Log: Performs delete operation on log files.
Log::deleteAllLogs() — Method in class Log: Deletes all logs.
Log::deleteAppLog() — Method in class Log: Deletes app.log.
Log::deleteCliLog() — Method in class Log: Deletes cli.log.
Log::deletePHPUnitLog() — Method in class Log: Deletes phpunit.log.
Migrate::dropAllTables() — Method in class Migrate: Drops all tables from the database without using down function.
Notifications::dryRun() — Method in class Notifications: Perform a dry-run (no delivery). Prints the intended action and payload.
Queue::deleteJob() — Method in class Queue: Deletes a job
React::defaultComponentTemplate() — Method in class React: Generates a component with default export.
Tools::dotNotationVerify() — Method in class Tools: Checks if input is in dot notation. If in dot notation the string is placed in an array where the first index is the directory name. The second element is the file name. The structure is shown below:
Cookie::delete() — Method in class Cookie: Deletes a cookie from the $_COOKIE superglobal variable.
DB — Class in namespace Core: Support database operations.
DB::delete() — Method in class DB: Performs delete operation against SQL database.
FormHelper::displayErrors() — Method in class FormHelper: Returns list of errors.
Blueprint::date() — Method in class Blueprint: Define a date column.
Blueprint::dateTime() — Method in class Blueprint: Define a datetime column.
Blueprint::decimal() — Method in class Blueprint: Define a decimal column.
Blueprint::default() — Method in class Blueprint: Adds a DEFAULT value to the last defined column.
Blueprint::dropColumns() — Method in class Blueprint: Drops a column or group of columns. If a column has a restraint then warnings are presented to the user.
Blueprint::dropForeign() — Method in class Blueprint: Drops a foreign key constraint from the table (MySQL only).
Blueprint::dropIfExists() — Method in class Blueprint: Drops a table if it exists.
Blueprint::dropIndex() — Method in class Blueprint: Drops indexed value from the table.
Blueprint::dropPrimaryKey() — Method in class Blueprint: Drops primary key field from the table.
Blueprint::dropUnique() — Method in class Blueprint: Drops column with unique constraint from the table.
Blueprint::double() — Method in class Blueprint: Define a double column.
Migration::down() — Method in class Migration: Rollback the migration.
Schema::dropIfExists() — Method in class Schema: Drop a table if it exists.
QueuePreferences::delay() — Method in class QueuePreferences: Get the delay before the job/listener should be processed.
EventDispatcher::dispatch() — Method in class EventDispatcher: Dispatches an event
EventManager::dispatcher() — Method in class EventManager: Get the dispatcher (after boot)
$ Api#defaultHeaders — Property in class Api: Default headers sent on every request (merged with per-call headers).
$ Api#defaultQuery — Property in class Api: Default query parameters merged into every request (per-call overrides).
$ Api#defaultTtl — Property in class Api: Default TTL (seconds) for GET cache. 0 disables caching.
DatabaseChannel — Class in namespace Core\Lib\Notifications\Channels: Database-backed notification channel.
DatabaseQueueDriver — Class in namespace Core\Lib\Queue: Implements the QueueDriverInterface. This driver implements functions that support database queue operations.
DatabaseQueueDriver::delete() — Method in class DatabaseQueueDriver: Deletes a job from the queue.
$ QueuedListenerJob#delay — Property in class QueuedListenerJob: Initial delay before the job becomes available to workers (seconds).
QueuedListenerJob::delay() — Method in class QueuedListenerJob: Sets delay for a job.
QueueDriverInterface::delete() — Method in class QueueDriverInterface: Deletes a job from the queue.
$ QueueManager#driver — Property in class QueueManager: The driver that is being used.
QueueManager::delete() — Method in class QueueManager: Delete a job from the queue by its identifier.
QueueManager::dispatch() — Method in class QueueManager: Dispatch a new job onto the queue.
QueueableJobInterface::delay() — Method in class QueueableJobInterface: Sets delay for a job.
RedisQueueDriver::delete() — Method in class RedisQueueDriver: Deletes a job from the queue. Is a no-op with Redis.
Vite::devTags() — Method in class Vite: Adds dev tags.
Arr::deepMerge() — Method in class Arr: Recursively merge two or more arrays.
Arr::diffAssocRecursive() — Method in class Arr: Recursively compute the difference between two arrays with keys.
Arr::dot() — Method in class Arr: Convert a multi-dimensional array into dot notation keys.
ArraySet::diff() — Method in class ArraySet: Get the difference between the current array and another array.
ArraySet::dot() — Method in class ArraySet: Convert an array into dot notation.
DateTime — Class in namespace Core\Lib\Utilities: Supports ability to manipulate how time is displayed. Most functions are wrappers for those found in the Carbon class.
Model::data() — Method in class Model: Grab object and if we just need data for smaller result set.
Model::delete() — Method in class Model: Wrapper for database delete function. If not softDelete we set it.
$ ACL#deleted — Property in class ACL: Deleted
$ EmailAttachments#deleted — Property in class EmailAttachments: Deleted
$ EmailAttachments#description — Property in class EmailAttachments: Description
$ Notifications#data — Property in class Notifications: Notification data.
$ ProfileImages#deleted — Property in class ProfileImages: Deleted value, defaults to 0.
ProfileImages::deleteById() — Method in class ProfileImages: Deletes a profile image by id.
ProfileImages::deleteImages() — Method in class ProfileImages: Sets delete field in profile_images table to 1 when user is deleted from users table. Accepts parameter for toggling on or off unlink to permanently image file.
ACLService::deleteIfAllowed() — Method in class ACLService: Deletes ACL if allowed.
AttachmentService::deleteAttachment() — Method in class AttachmentService: Deletes an attachment
DashboardService — Class in namespace Core\Services: Supports admin dashboard operations.
UserService::deleteIfAllowed() — Method in class UserService: Deletes user if not admin and unlinks profile images if $unlink is set to true.
UserService::deleteProfileImage() — Method in class UserService: Deletes profile image
Session::delete() — Method in class Session: Removes CURRENT_USER_SESSION_NAME from the $_SESSION superglobal array when a user logs out of a user session.
Session::displayMessage() — Method in class Session: Displays messages related to actions a user may perform.

E

DropTablesCommand::execute() — Method in class DropTablesCommand: Executes the command
GenerateControllerCommand::execute() — Method in class GenerateControllerCommand: Executes the command
GenerateMigrationCommand::execute() — Method in class GenerateMigrationCommand: Executes the command
GenerateModelCommand::execute() — Method in class GenerateModelCommand: Executes the command
MakeAclCommand::execute() — Method in class MakeAclCommand: Executes the command
MakeCSSCommand::execute() — Method in class MakeCSSCommand: Executes the command
MakeCommand::execute() — Method in class MakeCommand: Executes the command
MakeComponentCommand::execute() — Method in class MakeComponentCommand: Executes the command
MakeEmailCommand::execute() — Method in class MakeEmailCommand: Executes the command
MakeEmailLayoutCommand::execute() — Method in class MakeEmailLayoutCommand: Executes the command
MakeEventCommand::execute() — Method in class MakeEventCommand: Executes the command
MakeEventServiceProviderCommand::execute() — Method in class MakeEventServiceProviderCommand: Executes the command
MakeHelperCommand::execute() — Method in class MakeHelperCommand: Executes the command
MakeJobCommand::execute() — Method in class MakeJobCommand: Executes the command
MakeLayoutCommand::execute() — Method in class MakeLayoutCommand: Executes the command
MakeListenerCommand::execute() — Method in class MakeListenerCommand: Executes the command
MakeMailerCommand::execute() — Method in class MakeMailerCommand: Executes the command
MakeMenuCommand::execute() — Method in class MakeMenuCommand: Executes the command
MakeNotificationCommand::execute() — Method in class MakeNotificationCommand: Executes the command
MakeReactComponentCommand::execute() — Method in class MakeReactComponentCommand: Executes the command
MakeReactPageCommand::execute() — Method in class MakeReactPageCommand: Executes the command
MakeReactUtilCommand::execute() — Method in class MakeReactUtilCommand: Executes the command
MakeSeederCommand::execute() — Method in class MakeSeederCommand: Executes the command
MakeServiceCommand::execute() — Method in class MakeServiceCommand: Executes the command
MakeTestCommand::execute() — Method in class MakeTestCommand: Executes the command
MakeValidatorCommand::execute() — Method in class MakeValidatorCommand: Executes the command
MakeViewCommand::execute() — Method in class MakeViewCommand: Executes the command
MakeWidgetCommand::execute() — Method in class MakeWidgetCommand: Executes the command
MigrateFreshCommand::execute() — Method in class MigrateFreshCommand: Executes the command
MigrateRefreshCommand::execute() — Method in class MigrateRefreshCommand: Executes the command
MigrateRollbackCommand::execute() — Method in class MigrateRollbackCommand: Executes the command
MigrateStatusCommand::execute() — Method in class MigrateStatusCommand: Executes the command
NotificationTestCommand::execute() — Method in class NotificationTestCommand: Executes the command
NotificationsMigrationCommand::execute() — Method in class NotificationsMigrationCommand: Executes the command
NotificationsPruneCommand::execute() — Method in class NotificationsPruneCommand: Executes the command
QueueMigrationCommand::execute() — Method in class QueueMigrationCommand: Executes the command
QueueWorkerCommand::execute() — Method in class QueueWorkerCommand: Executes the command
ReactAuthCommand::execute() — Method in class ReactAuthCommand: Executes the command
ReactErrorCommand::execute() — Method in class ReactErrorCommand: Executes the command
ReactHomeCommand::execute() — Method in class ReactHomeCommand: Executes the command
ReactProfileCommand::execute() — Method in class ReactProfileCommand: Executes the command
RemoveLogsCommand::execute() — Method in class RemoveLogsCommand: Executes the command
RemoveProfileImagesCommand::execute() — Method in class RemoveProfileImagesCommand: Executes the command
RunMigrationCommand::execute() — Method in class RunMigrationCommand: Executes the command
RunTestCommand::execute() — Method in class RunTestCommand: Executes the command
SeedCommand::execute() — Method in class SeedCommand: Executes the command
ServeCommand::execute() — Method in class ServeCommand: Executes the command
ServeDocsCommand::execute() — Method in class ServeDocsCommand: Executes the command.
ServeUserGuideCommand::execute() — Method in class ServeUserGuideCommand: Executes the command.
TinkerCommand::execute() — Method in class TinkerCommand: Executes the command
Email — Class in namespace Console\Helpers: Supports commands related to the MailerService.
Events — Class in namespace Console\Helpers: Supports operations related to Events/Listeners.
Events::eventTemplate() — Method in class Events: Template for new event.
Events::eventServiceProviderTemplate() — Method in class Events: Template for event service provider.
React::errorNotFoundComponent() — Method in class React: Generates the error/NotFound.jsx component.
ReactStubs::errorNotFound() — Method in class ReactStubs: Stub for restoring required error/NotFound.jsx page component if accidentally deleted.
Cookie::exists() — Method in class Cookie: Checks if a particular cookie exists in the $_COOKIE superglobal variable.
DB::error() — Method in class DB: Getter function for the $_error variable.
ErrorHandler — Class in namespace Core: Performs error handling for application.
FormHelper::emailBlock() — Method in class FormHelper: Renders an HTML div element that surrounds an input of type email.
FormHelper::errorMsg() — Method in class FormHelper: Renders an error message for a particular form field.
Blueprint::enum() — Method in class Blueprint: Define an enum column (MySQL only).
EventDispatcher — Class in namespace Core\Lib\Events: Handles operations related to dispatching events.
EventDispatcher::enqueueListener() — Method in class EventDispatcher: Enqueue an event listener for asynchronous execution.
EventManager — Class in namespace Core\Lib\Events: Manages the registration and dispatching of events.
Uploads::errorReporting() — Method in class Uploads: Processes list of errors associated with uploads and makes them presentable to user during validation.
EventServiceProvider — Class in namespace Core\Lib\Providers: Internal EventServiceProvider for builtin events.
$ QueuedListenerJob#eventClass — Property in class QueuedListenerJob: Fully-qualified class name of the event to be rehydrated.
$ QueuedListenerJob#eventPayload — Property in class QueuedListenerJob: Serialized representation of the event's state.
Arr::except() — Method in class Arr: Get all items except the specified keys.
Arr::exists() — Method in class Arr: Check if a key exists in an array (non-dot notation).
ArraySet::each() — Method in class ArraySet: Iterate over each item and apply a callback.
ArraySet::except() — Method in class ArraySet: Remove specified keys from the array.
ArraySet::exists() — Method in class ArraySet: Determine if a key exists in an array.
Env — Class in namespace Core\Lib\Utilities: Class Env
Str::endsWith() — Method in class Str: Determine if a string ends with a given substring.
Str::excerpt() — Method in class Str: Create excerpts around specific words within a string.
EmailAttachments — Class in namespace Core\Models: Implements features of the EmailAttachments class.
$ Queue#exception — Property in class Queue: Exceptions
Queue::exceptionMessaging() — Method in class Queue: Handles tasks related to exceptions and retry of jobs.
UserService::ensureAuthenticatedUser() — Method in class UserService: Acts as safeguard to ensure incorrect user is not updated.
Session::exists() — Method in class Session: Checks if a session by user name exists.
EmailValidator — Class in namespace Core\Validators: Child class that performs validation for E-mail fields.
View::end() — Method in class View: Sets the end for a particular section of content. When called it takes _outputBuffer, cleans it, and outputs it to the screen. In the absence of a previous call to the start() function a message requesting you to call start() is displayed.

F

Migrate::fileName() — Method in class Migrate: Generates file/class name for migration.
Test::featureTests() — Method in class Test: Returns array containing all filenames in Feature directory.
View::formComponent() — Method in class View: Generates content of form component.
DB::find() — Method in class DB: Performs find operation against the database. The user can use parameters such as conditions, bind, order, limit, and sort.
DB::findFirst() — Method in class DB: Returns the first result performed by an SQL query. It is a wrapper for the _read function for this purpose.
DB::findTotal() — Method in class DB: Returns number of records in a table.
DB::first() — Method in class DB: Returns first result in the _result array.
FrameworkException — Class in namespace Core\Exceptions: Base class for this framework's exceptions that extends the Exception class.
FrameworkRuntimeException — Class in namespace Core\Exceptions: Base class for this framework's exceptions that extends the RuntimeException class.
FormHelper — Class in namespace Core: Contains functions for building form elements of various types.
Blueprint::float() — Method in class Blueprint: Define a float column.
Blueprint::foreign() — Method in class Blueprint: Define a foreign key (MySQL only).
UserRegistered::fromPayload() — Method in class UserRegistered: Retrieves information from payload array and returns new instance of this class.
Api::flattenHeaders() — Method in class Api: Convert an associative array of headers into "Key: Value" lines.
QueuedListenerJob::from() — Method in class QueuedListenerJob: Factory method to build a job from a listener class and an event instance.
Arr::fill() — Method in class Arr: Fill an array with a specified value.
Arr::filter() — Method in class Arr: Filter an array using a callback function.
Arr::filterByKeys() — Method in class Arr: Filter an array to include only the specified keys.
Arr::filterByValue() — Method in class Arr: Filter an array by its values.
Arr::first() — Method in class Arr: Get the first element that passes a given test.
Arr::flatten() — Method in class Arr: Flatten a multi-dimensional array into a single level.
Arr::flattenWithDepth() — Method in class Arr: Flatten an array up to a specified depth.
Arr::flattenKeys() — Method in class Arr: Convert a multi-dimensional array into dot notation keys.
Arr::forget() — Method in class Arr: Remove a value from an array using dot notation.
ArraySet::fill() — Method in class ArraySet: Fill an array with a specified value.
ArraySet::filter() — Method in class ArraySet: Filters the array using a callback function.
ArraySet::first() — Method in class ArraySet: Get the first element that matches a condition.
ArraySet::firstKey() — Method in class ArraySet: Get the first key of the array.
ArraySet::flatten() — Method in class ArraySet: Flatten a multi-dimensional array into a single level.
ArraySet::flip() — Method in class ArraySet: Swap keys with values in the array.
ArraySet::forget() — Method in class ArraySet: Remove a specific key from the array.
DateTime::formatTime() — Method in class DateTime: Returns string that describes time. The results can be set using constants, locale, and timezone.
Str::finish() — Method in class Str: Ensure a string ends with a given value.
Model::find() — Method in class Model: Wrapper for the find function that is found in the DB class.
Model::findById() — Method in class Model: Get result from database by primary key ID.
Model::findByTable() — Method in class Model: Performs a database query against a specified table using the same query-building logic as the default find method.
Model::findAllByUserId() — Method in class Model: Retrieves list of all records within a table related to a user.
Model::findFirst() — Method in class Model: Wrapper for the findFirst function that is found in the DB class.
Model::findTotal() — Method in class Model: Returns number of records in a table. A wrapper function for findTotal function in DB class.
EmailAttachments::formatBytes() — Method in class EmailAttachments: Formats size of attachment to human readable format.
ProfileImages::findCurrentProfileImage() — Method in class ProfileImages: Returns currently set profile image for a user.
ProfileImages::findByUserId() — Method in class ProfileImages: Finds all profile images for a user.
$ Queue#failed_at — Property in class Queue: Failed at.
Queue::failedAt() — Method in class Queue: Logs message indicating job permanently failed and returns current timestamp.
Queue::findFirstWithLock() — Method in class Queue: Find first with lock
Queue::findJob() — Method in class Queue: Returns record for job based on id found in associative array.
NotificationService::flashUnreadNotifications() — Method in class NotificationService: Adds notification information to Session Messages for currently logged in user.
$ CustomValidator#field — Property in class CustomValidator: Name of field being validated.

G

GenerateControllerCommand — Class in namespace Console\Commands: Supports ability to generate new controller class by typing make:controller.
GenerateMigrationCommand — Class in namespace Console\Commands: Supports ability to generate new migration file.
GenerateModelCommand — Class in namespace Console\Commands: Supports ability to generate new model class by typing make:model.
MigrationStatus::getBatch() — Method in class MigrationStatus: Getter function for batch;
MigrationStatus::getName() — Method in class MigrationStatus: Getter function for migration class' name.
MigrationStatus::getStatus() — Method in class MigrationStatus: Getter function for status of the migration.
Cookie::get() — Method in class Cookie: The name of the cookie we want to work with that is found in the $_COOKIE superglobal.
DB::getColumns() — Method in class DB: Returns columns for a table.
DB::getInstance() — Method in class DB: An instance of this class set as a variable. To be used in other class because we can't use $this.
DB::getPDO() — Method in class DB: Returns instance of PDO class.
DB::groupByColumn() — Method in class DB: Appropriately formats column for query with GROUP BY operations. A call to the ANY_VALUE function is added if the DB driver is MySQL or MariaDB.
FormHelper::generateToken() — Method in class FormHelper: Creates a randomly generated csrf token.
Helper::getObjectProperties() — Method in class Helper: Gets the properties of the given object
Helper::getProfileImage() — Method in class Helper: Retrieves URL user's current profile image.
Input::get() — Method in class Input: Supports operations related to handling POST and GET requests.
Input::getRequestMethod() — Method in class Input: Returns the request element within the $_SERVER superglobal array.
Migration::getNextBatch() — Method in class Migration: Get value for batch field for next set of migrations.
Uploads::generateUploadFilename() — Method in class Uploads: Generates a unique filename for an uploaded file while preserving its extension.
Uploads::getFiles() — Method in class Uploads: Getter function for the $_files array.
Api::get() — Method in class Api: Perform a GET request that expects a JSON response.
JsonResponse::get() — Method in class JsonResponse: Supports operations related to handling POST and GET requests.
AbstractMailer::getData() — Method in class AbstractMailer: Used to retrieve data to be used in E-mail.
AbstractMailer::getSubject() — Method in class AbstractMailer: Returns subject for E-mail.
AbstractMailer::getTemplate() — Method in class AbstractMailer: Returns the template to be used.
Attachments::getAllowedMimeTypes() — Method in class Attachments: Gets the values from the MIME_TYPES array.
ApplicationTestCase::get() — Method in class ApplicationTestCase: Simulates an HTTP GET request to a given URI by resolving and executing the corresponding controller and action, capturing the output.
TestResponse::getContent() — Method in class TestResponse: Returns the response content.
Arr::get() — Method in class Arr: Get a value from an array using dot notation.
Arr::groupBy() — Method in class Arr: Group an array by a given key.
ArraySet::get() — Method in class ArraySet: Get a value from the array using dot notation.
Config::get() — Method in class Config: Get a configuration value.
Env::get() — Method in class Env: Retrieves an environment variable.
Model::getColumns() — Method in class Model: Gets columns from table.
Model::getColumnsForSave() — Method in class Model: Gets an associative array of field values for insert or updating.
Model::getDb() — Method in class Model: Returns an instance of the DB class.
Model::getErrorMessages() — Method in class Model: Displays error messages when form validation fails.
ACL::getOptionsForForm() — Method in class ACL: Generates list of ACL options based on ACL table. Compatible with dropdown and checkbox group elements.
ACL::getACLs() — Method in class ACL: Retrieves list of all ACLs sorted by the acl field.
EmailAttachments::getAllowedFileTypes() — Method in class EmailAttachments: Getter function for $allowedFileTypes array
EmailAttachments::getMaxAllowedFileSize() — Method in class EmailAttachments: Getter function for $maxAllowedFileSize.
Login::getRememberMeChecked() — Method in class Login: Returns result for remember me checkbox so user stays logged in if it's checked.
ProfileImages::getAllowedFileTypes() — Method in class ProfileImages: Getter function for $allowedFileTypes array
ProfileImages::getMaxAllowedFileSize() — Method in class ProfileImages: Getter function for $maxAllowedFileSize.
UserSessions::getFromCookie() — Method in class UserSessions: Retrieves User Session information from cookie.
Router::getMenu() — Method in class Router: Parses menu_acl.json file to determine menu contents depending on acl of user.
Session::get() — Method in class Session: Getter function that returns the $_SESSION superglobal associative array.

H

CommandHelper::helperTemplate() — Method in class CommandHelper: Creates new helper class.
React::homeComponent() — Method in class React: Generates the home/Index.jsx component.
ReactStubs::homeIndex() — Method in class ReactStubs: Stub for home/Index.jsx page component.
Tools::hasConstant() — Method in class Tools: Checks if value for background color or text color matches list of available constants.
FormHelper::hidden() — Method in class FormHelper: Generates a hidden input element.
Helper — Class in namespace Core: Helper and utility functions.
EventDispatcher::handleListener() — Method in class EventDispatcher: Handle a registered listener in any supported shape.
EventDispatcher::hasQueuePreferences() — Method in class EventDispatcher: Check if a listener provides custom queue preferences.
Uploads::handleUpload() — Method in class Uploads: Handles file uploads and returns an Uploads instance if valid.
SendAccountDeactivatedEmail::handle() — Method in class SendAccountDeactivatedEmail: Handles event for sending account deactivated E-mail.
SendPasswordResetEmail::handle() — Method in class SendPasswordResetEmail: Handles event for sending password reset E-mail.
SendPasswordUpdateEmail::handle() — Method in class SendPasswordUpdateEmail: Handles event for sending password updated E-mail.
SendRegistrationEmail::handle() — Method in class SendRegistrationEmail: Handles event for sending user registered E-mail.
ChannelRegistry::has() — Method in class ChannelRegistry: Checks if channel name exists.
QueuedListenerJob::handle() — Method in class QueuedListenerJob: The logic that should be executed when the job is processed.
QueueableJobInterface::handle() — Method in class QueueableJobInterface: The logic that should be executed when the job is processed.
Arr::has() — Method in class Arr: Check if an array has a given key using dot notation.
Arr::hasAllKeys() — Method in class Arr: Check if all given keys exist in the array.
Arr::hasAnyKey() — Method in class Arr: Check if at least one key exists in the array.
Arr::hasAny() — Method in class Arr: Determine if at least one of the given keys exists in the array.
ArraySet::has() — Method in class ArraySet: Check if a key exists in the array.
ArraySet::hasAny() — Method in class ArraySet: Determine if at least one of the given keys exists in the array.
Str::headline() — Method in class Str: Convert a string to headline case.
Queue::hasExceededMaxAttempts() — Method in class Queue: Test if job as exceeded limit for maximum allowed attempts.
Router::hasAccess() — Method in class Router: Checks if user has access to a particular section of the site and grants access if that is the case.
AuthService::hashPassword() — Method in class AuthService: Hashes password.
UserService::handleProfileImages() — Method in class UserService: Uploads and sorts profile images.
HasTimestamps — Class in namespace Core\Traits: Creates the $created_at and $updated_at fields and performs the operation that updates timestamps.

I

Queue::isValidJob() — Method in class Queue: Test if name of job class is valid.
Queue::iterations() — Method in class Queue: Determines number of iterations to run worker
$ Test#inputOptions — Property in class Test: A string of input options provided as input when running the test command.
Tools::info() — Method in class Tools: Generates output messages for console commands.
RestrictedController::indexAction() — Method in class RestrictedController: This controller's default action.
DB::insert() — Method in class DB: Perform insert operations against the database.
DB::inTransaction() — Method in class DB: Checks if a transaction is currently active.
ErrorHandler::initialize() — Method in class ErrorHandler: Performs global exception handling, global error handling, and initialized whoops.
InvalidPayloadException — Class in namespace Core\Exceptions\Notifications: Handles cases when there are invalid payloads. Extends the NotificationException class.
FormHelper::inputBlock() — Method in class FormHelper: Assists in the development of forms input blocks in forms. It accepts parameters for setting attribute tags in the form section. Not to be used for inputs of type "Submit" For submit inputs use the submitBlock or submitTag functions.
Input — Class in namespace Core: Input class handles requests to the server.
Input::isGet() — Method in class Input: Checks if the REQUEST_METHOD is GET.
Input::isPost() — Method in class Input: Checks if the REQUEST_METHOD is POST.
Input::isPut() — Method in class Input: Checks if the REQUEST_METHOD is PUT.
Blueprint::id() — Method in class Blueprint: Add an ID column (primary key).
Blueprint::index() — Method in class Blueprint: Define an index.
Blueprint::integer() — Method in class Blueprint: Define an integer column.
EventDispatcher::isEnqueueListener() — Method in class EventDispatcher: Determine if the listener should be enqueued and enqueue it if applicable.
Logger::init() — Method in class Logger: Initializes the log file based on the environment (CLI or Web).
MailChannel::isTemplate() — Method in class MailChannel: Determines if mail will be using a template.
Vite::isDev() — Method in class Vite: Simple env-based dev check.
Arr::insertBefore() — Method in class Arr: Insert an element before a given key in an array.
Arr::insertAfter() — Method in class Arr: Insert an element after a given key in an array.
Arr::isArray() — Method in class Arr: Determine if a given value is an array.
Arr::isAssoc() — Method in class Arr: Determine if an array is associative (i.e., contains at least one non-numeric key).
Arr::isEmpty() — Method in class Arr: Check if the given array is empty.
Arr::isNotEmpty() — Method in class Arr: Check if the given array is not empty.
$ ArraySet#items — Property in class ArraySet: Items for array.
ArraySet::intersect() — Method in class ArraySet: Get the intersection of the current array and another array.
ArraySet::intersectKeys() — Method in class ArraySet: Get elements whose keys exist in another array.
ArraySet::implode() — Method in class ArraySet: Join array elements with a string.
ArraySet::isArray() — Method in class ArraySet: Check if the given value is an array.
ArraySet::isEmpty() — Method in class ArraySet: Check if the array is empty.
Str::isAscii() — Method in class Str: Check if the given string is pure ASCII.
Str::isEmpty() — Method in class Str: Determine if a string is empty.
Str::isJson() — Method in class Str: Determine if a string is a valid JSON.
Str::isUuid() — Method in class Str: Check if a string is a valid UUID.
$ Model#id — Property in class Model: The current id.
Model::insert() — Method in class Model: Wrapper for database insert function.
Model::isNew() — Method in class Model: Checks if an object is a new insertion or an existing record.
$ ACL#id — Property in class ACL: The current id.
ACL::isAssignedToUsers() — Method in class ACL: Check if ACL is assigned to any users
$ EmailAttachments#id — Property in class EmailAttachments: The primary key id
$ Notifications#id — Property in class Notifications: The id for this notification.
$ ProfileImages#id — Property in class ProfileImages: ID for this image.
$ Queue#id — Property in class Queue: ID for item in queue.
Queue::isQueueableClass() — Method in class Queue: Checks if class exists and that it implements the QueueableJobInterface.
$ UserSessions#id — Property in class UserSessions: The id for the session.
SessionManager::initialize() — Method in class SessionManager: Checks if session exists and logs user in. Logs user out if account status is inactive.
$ CustomValidator#includeDeleted — Property in class CustomValidator: Include deleted default is false.

J

Queue::jobTemplate() — Method in class Queue: Template for Jobs class.
JsonResponse — Class in namespace Core\Lib\Http: A trait that support operations related to APIs and their associated JSON responses.
JsonResponse::jsonError() — Method in class JsonResponse: Makes JSON Response for error payloads.
JsonResponse::jsonResponse() — Method in class JsonResponse: Sends a JSON response with headers and status code.

K

Arr::keys() — Method in class Arr: Get all the keys from an array.
Arr::keyBy() — Method in class Arr: Reindex an array using a specified key.
ArraySet::keys() — Method in class ArraySet: Get all keys of the array.
ArraySet::keyBy() — Method in class ArraySet: Key an array by a specific field.
ArraySet::krsort() — Method in class ArraySet: Sort the array by keys in descending order.
ArraySet::ksort() — Method in class ArraySet: Sort the array by keys in ascending order.
Str::kebab() — Method in class Str: Convert a string to kebab-case.

L

Email::layoutPath() — Method in class Email: Creates directory for layout if it does not exist.
Email::layoutTemplate() — Method in class Email: Template for E-mail layout.
Events::listenerTemplate() — Method in class Events: Template for event listener class.
Log — Class in namespace Console\Helpers: Supports ability to manage logs.
View::layout() — Method in class View: Generates a layout compatible with React.js
Controller::logViewForTesting() — Method in class Controller: Captures the current View instance during testing so that test assertions (e.g., assertViewContains) can access view-bound variables.
DB::lastID() — Method in class DB: The primary key ID of the last insert operation.
LoggerException — Class in namespace Core\Exceptions\Logger: Handles exceptions related to file logging.
LoggerLevelException — Class in namespace Core\Exceptions\Logger: Handles exceptions related to Logger severity levels.
LayoutNotFoundException — Class in namespace Core\Exceptions\View: Class to handle events related to layouts not being found.
$ EventDispatcher#listeners — Property in class EventDispatcher: An array of registered listeners.
EventDispatcher::listen() — Method in class EventDispatcher: Listens for an event.
Logger — Class in namespace Core\Lib\Logging: Supports the ability to produce logging.
$ Logger#logFile — Property in class Logger: Full path and name of current log file.
Logger::log() — Method in class Logger: Performs operations for adding content to log files.
$ AbstractMailer#layout — Property in class AbstractMailer: The layout to be used with email.
MailerService::layoutPath() — Method in class MailerService: Supports ability to use alternative layout paths.
LogChannel — Class in namespace Core\Lib\Notifications\Channels: Notification channel that writes notifications to the application log.
LogChannel::logData() — Method in class LogChannel: Build the consolidated "data" bag for logging.
LogChannel::logMessage() — Method in class LogChannel: Determine the human‑readable message to log.
$ EventServiceProvider#listen — Property in class EventServiceProvider: The event listener mappings for the application's built-in framework events.
$ ServiceProvider#listen — Property in class ServiceProvider: The event listener mappings for the application's built-in framework events.
$ QueuedListenerJob#listenerClass — Property in class QueuedListenerJob: Fully-qualified class name of the listener to execute.
Vite::loadManifest() — Method in class Vite: Locate and decode the Vite manifest.
Arr::last() — Method in class Arr: Get the last element that passes a given test.
$ ArraySet#lastResult — Property in class ArraySet: The last result.
ArraySet::last() — Method in class ArraySet: Get the last element that matches a condition.
ArraySet::lastKey() — Method in class ArraySet: Get the last key of the array.
Config::load() — Method in class Config: Load all config files from a directory.
Env::load() — Method in class Env: Loads environment variables from a .env file.
Str::lastPosition() — Method in class Str: Find the position of the last occurrence of a substring.
Str::lcfirst() — Method in class Str: Converts the first character of a string to lowercase.
Str::length() — Method in class Str: Get the length of a string using multibyte support.
Str::levenshtein() — Method in class Str: Calculate Levenshtein distance between two strings.
Str::limit() — Method in class Str: Limit the number of characters in a string.
Str::lower() — Method in class Str: Convert a string to lowercase.
Login — Class in namespace Core\Models: Extends the Model class. Supports functions for the Login model.
AuthService::login() — Method in class AuthService: Processes login attempts
AuthService::loginAttempts() — Method in class AuthService: Tests for login attempts and sets session messages when there is a failed attempt or when account is locked.
AuthService::loginUser() — Method in class AuthService: Creates a session when the user logs in. A new record is added to the user_sessions table and a cookie is created if remember me is selected.
AuthService::loginUserFromCookie() — Method in class AuthService: Logs in user from cookie.
AuthService::logout() — Method in class AuthService: Logs user out.
AuthService::logoutUser() — Method in class AuthService: Perform logout operation on current logged in user. The record for the current logged in user is removed from the user_session table and the corresponding cookie is deleted.
LowerCharValidator — Class in namespace Core\Validators: Child class class that supports ability to check if field contains a lower case character in the field.

M

MakeAclCommand — Class in namespace Console\Commands: Supports ability to generate a menu_acl json file by running make:acl.
MakeCSSCommand — Class in namespace Console\Commands: Generates a new css file by typing make:css.
MakeCommand — Class in namespace Console\Commands: Supports ability to create new console command by running make:command.
MakeComponentCommand — Class in namespace Console\Commands: Supports ability to create components by running make:component.
MakeEmailCommand — Class in namespace Console\Commands: Generates a new email by running make:email.
MakeEmailLayoutCommand — Class in namespace Console\Commands: Generates a new email layout by typing make:email-layout.
MakeEventCommand — Class in namespace Console\Commands: Generates a new event class by typing make:event.
MakeEventServiceProviderCommand — Class in namespace Console\Commands: Generates a new event service provider class by running make:provider.
MakeHelperCommand — Class in namespace Console\Commands: Class for the make:command-helper command. This class generates helpers for your custom commands.
MakeJobCommand — Class in namespace Console\Commands: Generates a new Job class by running make:job.
MakeLayoutCommand — Class in namespace Console\Commands: Generates a new layout by running make:layout.
MakeListenerCommand — Class in namespace Console\Commands: Generates a new listener class by running make:listener.
MakeMailerCommand — Class in namespace Console\Commands: Generates a new custom mailer by running make:mailer.
MakeMenuCommand — Class in namespace Console\Commands: Supports ability to generate a new menu file by running make:menu.
MakeNotificationCommand — Class in namespace Console\Commands: Generates a new Notification class by running make:notification.
MakeReactComponentCommand — Class in namespace Console\Commands: Implements command for making a new react component by running react:component.
MakeReactPageCommand — Class in namespace Console\Commands: Implements command for making a new react view by running react:page.
MakeReactUtilCommand — Class in namespace Console\Commands: Implements command for making a new JavaScript utility by running react:util.
MakeSeederCommand — Class in namespace Console\Commands: Supports operations for the make:seeder command. Use this command to make a database seeder.
MakeServiceCommand — Class in namespace Console\Commands: Generates a new custom service by running make:service.
MakeTestCommand — Class in namespace Console\Commands: Supports ability to generate new test file by running make:test.
MakeValidatorCommand — Class in namespace Console\Commands: Generates a new Custom Form Validator by running make:validator.
MakeViewCommand — Class in namespace Console\Commands: Implements command for making a new view file by running make:view.
MakeWidgetCommand — Class in namespace Console\Commands: Implements command for making a new widget file by running make:widget.
MigrateFreshCommand — Class in namespace Console\Commands: Supports ability to drop all tables and recreate them by running migrate:fresh.
MigrateRefreshCommand — Class in namespace Console\Commands: Supports ability to drop tables with down function and recreate them with migrate:refresh.
MigrateRollbackCommand — Class in namespace Console\Commands: Supports ability to roll back database migrations.
MigrateStatusCommand — Class in namespace Console\Commands: Reports status of migrations.
CommandHelper::makeCommand() — Method in class CommandHelper: Generates new class that extends Command.
CommandHelper::makeHelper() — Method in class CommandHelper: Generates new class that contains functions that support multiple console commands.
DBSeeder::makeSeeder() — Method in class DBSeeder: Creates a class for seeding a database.
Email::mailerTemplate() — Method in class Email: Template for custom mailer class.
Email::makeEmail() — Method in class Email: Generates a new E-mail.
Email::makeLayout() — Method in class Email: Generates a new E-mail layout.
Email::makeMailer() — Method in class Email: Generates a new custom mailer class.
Events::makeEvent() — Method in class Events: Creates a new event class.
Events::makeEventServiceProvider() — Method in class Events: Creates a new event service provider.
Events::makeListener() — Method in class Events: Creates a new listener class.
Migrate — Class in namespace Console\Helpers: Helper class for migration related console commands.
Migrate::makeMigration() — Method in class Migrate: Generates a migration class for creating a new table.
Migrate::makeRenameMigration() — Method in class Migrate: Generates a migration class for renaming an existing table.
Migrate::makeUpdateMigration() — Method in class Migrate: Generates a migration class for updating existing table.
Migrate::migrate() — Method in class Migrate: Performs migration operation.
Migrate::migrationClass() — Method in class Migrate: Generates a new Migration class for creating a new table.
Migrate::migrationRenameClass() — Method in class Migrate: Generates a new Migration class for renaming an existing table.
Migrate::migrationUpdateClass() — Method in class Migrate: Generates a new Migration class for updating a table.
MigrationStatus — Class in namespace Console\Helpers: Supports the tracking of migration status for tables.
Model — Class in namespace Console\Helpers: Helper class for model related console commands.
Model::makeModel() — Method in class Model: Generates a new model class.
Model::modelTemplate() — Method in class Model: The default template for a new model class.
Notifications::makeNotification() — Method in class Notifications: Generate a new notification class file into {self::NOTIFICATION_PATH}.
Notifications::migrationTemplate() — Method in class Notifications: Template for the notifications migration class file.
Queue::makeJob() — Method in class Queue: Creates a new job class.
React::makeComponent() — Method in class React: Generates component under 'resources/js/components'.
React::makePage() — Method in class React: Generates a page view component under 'resources/js/pages/'.
React::makeUtility() — Method in class React: Generates a JavaScript file under 'resources/js/utils' to be use as support file with React.js front-end.
Services::makeService() — Method in class Services: Creates new Services class.
Test::makeFeatureTest() — Method in class Test: The template for a new Feature test class that extends ApplicationTestCase.
Test::makeTest() — Method in class Test: Creates a new test class. When --feature flag is provided a test feature class is created.
Test::makeUnitTest() — Method in class Test: The template for a new Unit Test class that extends TestCase.
Validator::makeValidator() — Method in class Validator: Generates a new user defined validator class.
View::makeCardComponent() — Method in class View: Writes card component to a file.
View::makeCSS() — Method in class View: Generates a new CSS file.
View::makeFormComponent() — Method in class View: Writes form component to file.
View::makeLayout() — Method in class View: Generates a new layout file.
View::makeMenu() — Method in class View: Generates a new menu file.
View::makeMenuAcl() — Method in class View: Generates a new menu_acl file.
View::makeTableComponent() — Method in class View: Writes table component to a file.
View::makeView() — Method in class View: Writes template for view to a file.
View::makeWidget() — Method in class View: Writes new file for widget.
View::menu() — Method in class View: Returns a string containing contents for a menu.
View::menuAcl() — Method in class View: Returns a string containing contents of a json menu acl file.
Blueprint::mediumInteger() — Method in class Blueprint: Define a medium integer column.
Migration — Class in namespace Core\Lib\Database: Supports database migration operations.
QueuePreferences::maxAttempts() — Method in class QueuePreferences: Get the maximum number of attempts for processing this job/listener.
$ AbstractMailer#mailer — Property in class AbstractMailer: The mailer service object sending the mail.
Attachments::mime() — Method in class Attachments: Returns the MIME type for a given file extension.
MailerService — Class in namespace Core\Lib\Mail: Supports E-mail infrastructure for this framework.
$ MailerService#mailer — Property in class MailerService: Mailer object.
MailerService::mailLogger() — Method in class MailerService: Logs each attempt at sending an E-mail.
$ ChannelRegistry#map — Property in class ChannelRegistry: Map of channel name => channel class.
MailChannel — Class in namespace Core\Lib\Notifications\Channels: Notification channel that sends email via the framework MailerService and/or AbstractMailer-based custom mailers.
$ QueuedListenerJob#maxAttempts — Property in class QueuedListenerJob: Maximum number of attempts before the job is considered failed.
QueuedListenerJob::maxAttempts() — Method in class QueuedListenerJob: Undocumented function
QueueableJobInterface::maxAttempts() — Method in class QueueableJobInterface: Undocumented function
ApplicationTestCase::mockFile() — Method in class ApplicationTestCase: Create a mock file for actions that require file input in form submissions.
Arr::map() — Method in class Arr: Apply a callback to each item in an array.
Arr::mapWithKeys() — Method in class Arr: Map an array while preserving keys.
Arr::merge() — Method in class Arr: Merge one or more arrays together.
ArraySet::make() — Method in class ArraySet: Create a new Arr instance from an array or a single value.
ArraySet::map() — Method in class ArraySet: Apply a callback function to each item in the array.
ArraySet::mapRecursive() — Method in class ArraySet: Apply a recursive callback function to each element in the array.
ArraySet::mapWithKeys() — Method in class ArraySet: Map an array using a callback that defines both keys and values.
ArraySet::merge() — Method in class ArraySet: Merge the current array with another array.
ArraySet::multisort() — Method in class ArraySet: Sort multiple arrays or multi-dimensional arrays.
Str::mask() — Method in class Str: Mask portions of a string with a given character.
Str::md5() — Method in class Str: Return the MD5 hash of a string.
Model — Class in namespace Core: Parent class for our models. Takes functions from DB wrapper and extract functionality further to make operations easier to use and improve extendability.
$ EmailAttachments#maxAllowedFileSize — Property in class EmailAttachments: Set your max file size.
$ EmailAttachments#mime_type — Property in class EmailAttachments: The mime type.
Notifications::markAsRead() — Method in class Notifications: Mark notification record as read.
Notifications::markAsReadById() — Method in class Notifications: Mark notification record as read by id.
$ ProfileImages#maxAllowedFileSize — Property in class ProfileImages: Max allowed size.
Queue::maxAttempts() — Method in class Queue: Returns maximum allowable attempts.
ACLService::manageAcls() — Method in class ACLService: Manages the adding and removing of ACLs.
$ CustomValidator#message — Property in class CustomValidator: Message when validation fails.
MatchesValidator — Class in namespace Core\Validators: Child class that performs validation for two fields that are required to have the same value.
MaxValidator — Class in namespace Core\Validators: Child class that performs validation for the maximum length of a value for a field.
MinValidator — Class in namespace Core\Validators: Child class that performs validation for the minimum length of a value for a field.

N

NotificationTestCommand — Class in namespace Console\Commands

Supports operations for testing a notification.

NotificationsMigrationCommand — Class in namespace Console\Commands

Supports ability to create new notifications migration file.

NotificationsPruneCommand — Class in namespace Console\Commands

Supports ability to run a migration file.

$ MigrationStatus#name — Property in class MigrationStatus

The name of the migration class.

Notifications — Class in namespace Console\Helpers

Utilities that support console commands related to Notifications:

Resolving notifiables and channels from CLI options
Building per-send payloads/overrides
Scaffolding notification classes and the notifications migration
Performing dry-runs and actual sends via a notifiable

Notifications::notificationClass() — Method in class Notifications

Build a fully-qualified notification class name.

Notifications::notificationClassExists() — Method in class Notifications

Determine if a notification class exists.

Notifications::notificationsMigration() — Method in class Notifications

Create a new notifications migration file on disk.

React::namedComponentTemplate() — Method in class React

Generates a named export component.

RestrictedController::noControllerAction() — Method in class RestrictedController

Handles case when controller is not found and sets 404 response.

RestrictedController::notFoundAction() — Method in class RestrictedController

Handles cases when view is not found and sets 404 response.

NotifiableRoutingException — Class in namespace Core\Exceptions\Notifications

Handles exceptions related to notification routing. Extends the NotificationException class.

NotificationException — Class in namespace Core\Exceptions\Notifications

Exception class for notifications that extends RuntimeException

Blueprint::nullable() — Method in class Blueprint

Modifies last column added to the schema and make it nullable.

DatabaseChannel::name() — Method in class DatabaseChannel

Short channel name used in Notification::via().

LogChannel::name() — Method in class LogChannel

Returns the canonical name of the channel.

MailChannel::name() — Method in class MailChannel

Short channel name used in Notification::via().

MailChannel::notifyWithBuildAndSend() — Method in class MailChannel

Setups notification using buildAndSend

MailChannel::notifyWithHTML() — Method in class MailChannel

Setups notification with html and with text optional.

MailChannel::notifyWithTemplate() — Method in class MailChannel

Setups notification with mail template.

Channel::name() — Method in class Channel

The short channel name used in via(): e.g. 'database', 'mail', 'sms'.

Notifiable — Class in namespace Core\Lib\Notifications

Adds notification capabilities to a model.

Notifiable::notify() — Method in class Notifiable

Send a notification to this notifiable through one or more channels.

Notifiable::notifications() — Method in class Notifiable

Retrieve this notifiable's unread notifications, newest first.

Notification — Class in namespace Core\Lib\Notifications

Base Notification class similar to Laravel's.

NotificationManager — Class in namespace Core\Lib\Notifications

Manages the registration for notification channels.

NotificationServiceProvider — Class in namespace Core\Lib\Providers

Service provider for notifications.

DateTime::nowPlusSeconds() — Method in class DateTime

Adds second passed as parameter to current time.

Str::numberFormat() — Method in class Str

Format a number with grouped thousands.

$ EmailAttachments#name — Property in class EmailAttachments

Name of the attachment.

Notifications — Class in namespace Core\Models

Implements features of the Notifications class.

$ Notifications#notifiable_type — Property in class Notifications

Notification type.

$ Notifications#notifiable_id — Property in class Notifications

Id of user to be notified.

Notifications::notificationsToPrune() — Method in class Notifications

Permanently delete old notifications from this model's table.

$ ProfileImages#name — Property in class ProfileImages

Name of the file.

AttachmentService::name() — Method in class AttachmentService

Sets name for the attachment.

NotificationService — Class in namespace Core\Services

Supports tasks related to notifications.

NotificationService::notifyUsers() — Method in class NotificationService

Sends notifications to users with a particular group.

NumberCharValidator — Class in namespace Core\Validators

Child class class that supports ability to check if field contains a numeric character in the field.

NumericValidator — Class in namespace Core\Validators

Child class that performs validation for fields than only accept numeric values.

O

$ Test#output — Property in class Test: The Symfony OutputInterface object.
$ Tools#output — Property in class Tools: Supports ability to log information to console.
Controller::onConstruct() — Method in class Controller: Function implemented by child model classes when models are instantiated.
RestrictedController::onConstruct() — Method in class RestrictedController: Function implemented by child model classes when models are instantiated.
FormHelper::optionsForSelect() — Method in class FormHelper: Generates options for select.
FormHelper::output() — Method in class FormHelper: Generates an HTML output element.
Pagination::offset() — Method in class Pagination: Calculates offset needed for pagination.
Arr::only() — Method in class Arr: Get only the specified keys from an array.
ArraySet::only() — Method in class ArraySet: Return only the specified keys from the array.
Model::onConstruct() — Method in class Model: Runs when the object is constructed.
EmailAttachments::onConstruct() — Method in class EmailAttachments: Implements onConstruct from parent class.

P

Notifications::prune() — Method in class Notifications: Prune old notifications using the model layer.
ProfileImageDir — Class in namespace Console\Helpers: Contains functions for creating and deleting the profile images directory.
React::profileComponents() — Method in class React: Generates the profile jsx components.
ReactStubs::profileImageSorter() — Method in class ReactStubs: Stub for ProfileImageSorter.jsx component.
ReactStubs::profileEdit() — Method in class ReactStubs: Stub for profile/Edit.jsx page component.
ReactStubs::profileIndex() — Method in class ReactStubs: Stub for profile/Index.jsx page component.
ReactStubs::profileUpdatePassword() — Method in class ReactStubs: Stub for profile/UpdatePassword.jsx page component
Test::parseOptions() — Method in class Test: Parses PHPUnit related arguments and ignore Symfony arguments.
Tools::pathExists() — Method in class Tools: Tests if a path exits and creates it if necessary.
FormHelper::posted_values() — Method in class FormHelper: Performs sanitization of values obtained during $_POST.
EventDispatcher::processCallableArray() — Method in class EventDispatcher: Process a listener provided as [FQCN|object, 'method'].
EventDispatcher::processClassString() — Method in class EventDispatcher: Process a listener provided as a fully-qualified class name.
Api::post() — Method in class Api: Perform a POST request with a JSON body and expect a JSON response.
JsonResponse::preflight() — Method in class JsonResponse: Respond to CORS preflight.
Attachments::path() — Method in class Attachments: Used to assemble array for attachment when path key is used.
Attachments::processAttachments() — Method in class Attachments: Process attachments to be sent.
PasswordResetMailer — Class in namespace Core\Lib\Mail: Class for generating a reset password E-mail.
LogChannel::payloadMessage() — Method in class LogChannel: Extract a string message from the payload, if present.
Pagination — Class in namespace Core\Lib\Pagination: Class that supports pagination for views.
Pagination::pagination() — Method in class Pagination: Renders Bootstrap 5 pagination controls.
Pagination::paginationParams() — Method in class Pagination: Builds parameters for pagination query.
DatabaseQueueDriver::pop() — Method in class DatabaseQueueDriver: Retrieves and reserves the next available job from the specified queue.
DatabaseQueueDriver::push() — Method in class DatabaseQueueDriver: Pushes a new job onto the specified queue.
QueueDriverInterface::pop() — Method in class QueueDriverInterface: Retrieves and reserves the next available job from the specified queue.
QueueDriverInterface::push() — Method in class QueueDriverInterface: Pushes a new job onto the specified queue.
QueueManager::push() — Method in class QueueManager: Push a raw payload onto the specified queue.
QueueManager::pop() — Method in class QueueManager: Retrieve (pop) the next available job from the specified queue.
RedisQueueDriver::pop() — Method in class RedisQueueDriver: Retrieves and reserves the next available job from the specified queue.
RedisQueueDriver::push() — Method in class RedisQueueDriver: Pushes a new job onto the specified queue.
Vite::prodTags() — Method in class Vite: Adds production tags.
ApplicationTestCase::post() — Method in class ApplicationTestCase: Simulates a POST request by setting $_POST data and executing the specified controller and action. Returns a TestResponse with the output and status.
ApplicationTestCase::put() — Method in class ApplicationTestCase: Simulates a DELETE request to a specified URI. This sets the request method to DELETE and runs the matching controller action.
Arr::partition() — Method in class Arr: Partition an array into two arrays: One where the callback returns true, the other where it returns false.
Arr::pluck() — Method in class Arr: Pluck a single key from an array.
Arr::prepend() — Method in class Arr: Prepend a value to an array.
Arr::pull() — Method in class Arr: Retrieve a value from the array and remove it.
Arr::push() — Method in class Arr: Push one or more values onto the end of an array.
ArraySet::pad() — Method in class ArraySet: Pad an array to the specified length with a value.
ArraySet::pluck() — Method in class ArraySet: Extract a specific key's values.
ArraySet::prepend() — Method in class ArraySet: Prepend a value to the beginning of the array.
ArraySet::pull() — Method in class ArraySet: Remove and return a value from the array.
ArraySet::push() — Method in class ArraySet: Add one or more values to the array.
Str::padLeft() — Method in class Str: Pad the left side of a string with a given character.
Str::padRight() — Method in class Str: Pad the right side of a string with a given character.
Str::pascal() — Method in class Str: Convert a string to PascalCase (StudlyCase).
Str::plural() — Method in class Str: Pluralize a word.
Str::position() — Method in class Str: Find the position of the first occurrence of a substring.
Model::populateObjData() — Method in class Model: Populates object with data.
$ EmailAttachments#path — Property in class EmailAttachments: Path to the attachment.
$ Login#password — Property in class Login: Password of user authenticating.
ProfileImages — Class in namespace Core\Models: Supports CRUD operations on profile image records.
$ Queue#payload — Property in class Queue: Payload
AttachmentService::previewAttachment() — Method in class AttachmentService: Generates preview for attachment in new tab.
AttachmentService::processAttachment() — Method in class AttachmentService: Sets fields for attachment record based on file information and performs uploads.
AuthService::passwordReset() — Method in class AuthService: Resets password.
AuthService::profileImageUpload() — Method in class AuthService: Handles upload for profile image.
DashboardService::paginateUsers() — Method in class DashboardService: Returns list of paginated users.
PhoneNumberValidator — Class in namespace Core\Validators: Validates input for phone numbers. Locale abbreviation needs to be set as a rule.

Q

QueueMigrationCommand — Class in namespace Console\Commands: Supports ability to create new notifications migration file.
QueueWorkerCommand — Class in namespace Console\Commands: Executes a queue worker.
Events::queueEventTemplate() — Method in class Events: Returns template for event class when queue flag is set.
Events::queueListenerTemplate() — Method in class Events: Generates a stub for queue listener class.
Queue — Class in namespace Console\Helpers: Supports commands related to queues.
Queue::queueTemplate() — Method in class Queue: Template for queue migration.
Queue::queueMigration() — Method in class Queue: Creates new queue migration.
DB::query() — Method in class DB: Performs database query operations that includes prepare, binding, execute, and fetch.
QueuePreferences — Class in namespace Core\Lib\Events\Contracts: Defines the contract for event listeners or jobs that can be queued.
QueuedListenerJob — Class in namespace Core\Lib\Queue\Jobs: Job wrapper that executes an event listener asynchronously.
QueueDriverInterface — Class in namespace Core\Lib\Queue: Interface QueueDriverInterface
QueueManager — Class in namespace Core\Lib\Queue: Manages queue / job dispatch system.
QueueableJobInterface — Class in namespace Core\Lib\Queue: Interface that all queueable jobs must implement.
Model::query() — Method in class Model: Wrapper for database query function.
Queue — Class in namespace Core\Models: Implements features of the Queue class.
$ Queue#queue — Property in class Queue: Name of queue.

R

ReactAuthCommand — Class in namespace Console\Commands: Implements command for generating the auth page components.
ReactErrorCommand — Class in namespace Console\Commands: Implements command for generating the error/NotFound.jsx page component.
ReactHomeCommand — Class in namespace Console\Commands: Implements command for generating the home/Index.jsx page component.
ReactProfileCommand — Class in namespace Console\Commands: Implements command for generating the profile page components.
RemoveLogsCommand — Class in namespace Console\Commands: Supports ability to delete log file.
RemoveProfileImagesCommand — Class in namespace Console\Commands: Run this after performing the migrate:refresh command to delete all existing profile images. May need sudo privileges.
RunMigrationCommand — Class in namespace Console\Commands: Supports ability to run a migration file.
RunTestCommand — Class in namespace Console\Commands: Supports ability to run a phpunit test with only the name of the test file is accepted as a required input.
Controller::resourceTemplate() — Method in class Controller: The template that contains additional useful functions for a controller.
Migrate::refresh() — Method in class Migrate: Performs refresh operation.
Migrate::rollback() — Method in class Migrate: Performs roll back operation
Migrate::rollbackStep() — Method in class Migrate: Perform step roll back.
Notifications::resolveNotifiable() — Method in class Notifications: Resolve a notifiable instance (or a sentinel string) from CLI input.
Notifications::resolveOverridesFromWith() — Method in class Notifications: Parse overrides from the --with option (key:value,key2:value2).
Notifications::resolveChannelsOverride() — Method in class Notifications: Resolve a channels override list from CLI input.
ProfileImageDir::rmdirProfileImageDirectories() — Method in class ProfileImageDir: Performs rmdir operation on the profile images directory.
React — Class in namespace Console\Helpers: Contains functions that perform operations for React.js relate CLI commands.
ReactStubs — Class in namespace Console\Helpers: A collection of React.js view, component, and util stubs.
Test::runTest() — Method in class Test: Runs the unit test contained in the TestCase class.
$ Controller#request — Property in class Controller: Instance of Input class that performs much of our request tasks.
RestrictedController — Class in namespace Core\Controllers: Implements support for the Restricted controller. Interactions that the user performs that are restricted will result in a relevant view being rendered.
DB::results() — Method in class DB: Returns value of query results.
DB::rollBack() — Method in class DB: Rolls back the current database transaction.
FormHelper::radioInput() — Method in class FormHelper: Creates an input element of type radio with an accompanying label element. Compatible with radio button groups.
Blueprint::renameColumn() — Method in class Blueprint: Renames a particular column
Blueprint::renameForeign() — Method in class Blueprint: Renames a foreign key.
Blueprint::renameIndex() — Method in class Blueprint: Renames an indexed column by preserving and reapplying the index.
Blueprint::renamePrimaryKey() — Method in class Blueprint: Renames the table's primary key.
Blueprint::renameUnique() — Method in class Blueprint: Renames a column with a unique constraint by preserving and reapplying the index.
Schema::rename() — Method in class Schema: Renames a table
Seeder::run() — Method in class Seeder: All seeders must implement the run method.
Uploads::restructureFiles() — Method in class Uploads: Restructures $_FILES data based on mode.
Uploads::runValidation() — Method in class Uploads: Performs validation tasks.
Api::readCache() — Method in class Api: Read a cached JSON response for a URL if it exists and is fresh.
Api::requestJson() — Method in class Api: Core HTTP request using cURL that decodes JSON and throws on errors.
MailerService::renderTemplateFile() — Method in class MailerService: Renders template file.
ChannelRegistry::register() — Method in class ChannelRegistry: Register (or override) a channel implementation under a short name.
ChannelRegistry::resolve() — Method in class ChannelRegistry: Resolve a channel by name into a concrete {Channel} instance.
MailChannel::requireUser() — Method in class MailChannel: Ensure the notifiable is the expected user type for AbstractMailer.
MailChannel::route() — Method in class MailChannel: Resolve recipient email from the notifiable.
NotificationServiceProvider::register() — Method in class NotificationServiceProvider: For future support for containers. Bind per-channel deps here.
ServiceProvider::register() — Method in class ServiceProvider: Default function to register bindings or event listeners. Can be overridden.
DatabaseQueueDriver::release() — Method in class DatabaseQueueDriver: Releases a job back onto the queue after a failure or delay.
QueuedListenerJob::rehydrateEvent() — Method in class QueuedListenerJob: Rebuild the event instance from the stored payload.
QueueDriverInterface::release() — Method in class QueueDriverInterface: Releases a job back onto the queue after a failure or delay.
QueueManager::release() — Method in class QueueManager: Release a job back onto the specified queue.
RedisQueueDriver — Class in namespace Core\Lib\Queue: Implements the QueueDriverInterface. This driver implements functions that support Redis queue operations.
$ RedisQueueDriver#redis — Property in class RedisQueueDriver: The redis client.
RedisQueueDriver::release() — Method in class RedisQueueDriver: Releases a job back onto the queue after a failure or delay.
Arr::random() — Method in class Arr: Get a random value or multiple values from an array.
Arr::reject() — Method in class Arr: Reject elements that match a given condition.
Arr::reverse() — Method in class Arr: Reverse the order of elements in an array.
Arr::rotate() — Method in class Arr: Rotate an array left or right.
ArraySet::random() — Method in class ArraySet: Get a random value or multiple values from the array.
ArraySet::reduce() — Method in class ArraySet: Reduce the array to a single value using a callback.
ArraySet::replace() — Method in class ArraySet: Replace values in the array with values from another array.
ArraySet::result() — Method in class ArraySet: Retrieve the result of the last operation.
ArraySet::reverse() — Method in class ArraySet: Reverse the order of the array.
ArraySet::rsort() — Method in class ArraySet: Sort the array in descending order.
Str::random() — Method in class Str: Generate a random string of a specified length.
Str::repeat() — Method in class Str: Repeat a string.
Str::replace() — Method in class Str: Replace all occurrences of the search string with the replacement string.
Str::replaceArray() — Method in class Str: Replace placeholders sequentially with values from an array.
Str::replaceFirst() — Method in class Str: Replace the first occurrence of a substring.
Str::replaceLast() — Method in class Str: Replace the last occurrence of a substring.
Str::replaceMultiple() — Method in class Str: Replace multiple occurrences of different values in a string.
Str::reverse() — Method in class Str: Reverse a given string.
Model::runValidation() — Method in class Model: Runs a validator object and sets validates boolean and adds error message if validator fails.
$ Login#remember_me — Property in class Login: Indicates if remember_me was selected.
$ Notifications#read_at — Property in class Notifications: Read at flag.
$ Queue#reserved_at — Property in class Queue: Reserved at.
Queue::reservedAt() — Method in class Queue: Updates reserved_at field.
Queue::reserveNext() — Method in class Queue: Attempts to atomically reserve the next available job from the queue.
Queue::resolveBackoffDelay() — Method in class Queue: Resolves backoff delay.
Router — Class in namespace Core: This class is responsible for routing between views.
Router::redirect() — Method in class Router: Performs redirect operations.
Router::route() — Method in class Router: Supports operations for routing. It parses the url to determine which page needs to be rendered. That path is parsed to determine the correct controller and action to use.
ACLService::removeAcl() — Method in class ACLService: Removes ACL from user's acl field array.
$ CustomValidator#rule — Property in class CustomValidator: Rule for validation success.
CustomValidator::runValidation() — Method in class CustomValidator: Signature for the runValidation function that must be implemented by each child class.
EmailValidator::runValidation() — Method in class EmailValidator: Signature for the runValidation function that must be implemented by each child class.
LowerCharValidator::runValidation() — Method in class LowerCharValidator: Signature for the runValidation function that must be implemented by each child class.
MatchesValidator::runValidation() — Method in class MatchesValidator: Signature for the runValidation function that must be implemented by each child class.
MaxValidator::runValidation() — Method in class MaxValidator: Signature for the runValidation function that must be implemented by each child class.
MinValidator::runValidation() — Method in class MinValidator: Signature for the runValidation function that must be implemented by each child class.
NumberCharValidator::runValidation() — Method in class NumberCharValidator: Signature for the runValidation function that must be implemented by each child class.
NumericValidator::runValidation() — Method in class NumericValidator: Signature for the runValidation function that must be implemented by each child class.
PhoneNumberValidator::runValidation() — Method in class PhoneNumberValidator: Signature for the runValidation function that must be implemented by each child class.
RequiredValidator — Class in namespace Core\Validators: Child class that performs validation for fields that are required.
RequiredValidator::runValidation() — Method in class RequiredValidator: Signature for the runValidation function that must be implemented by each child class.
SpecialCharValidator::runValidation() — Method in class SpecialCharValidator: Signature for the runValidation function that must be implemented by each child class.
UniqueValidator::runValidation() — Method in class UniqueValidator: Signature for the runValidation function that must be implemented by each child class.
UpperCharValidator::runValidation() — Method in class UpperCharValidator: Signature for the runValidation function that must be implemented by each child class.
View::render() — Method in class View: Performs render operations for a particular view.
View::renderJsx() — Method in class View: Renders a React.js file.
View::renderWidget() — Method in class View: Renders a single widget view file with given data.
View::renderWidgets() — Method in class View: Renders widgets for a given section.

S

SeedCommand — Class in namespace Console\Commands: Runs the command for seeding database with random data.
ServeCommand — Class in namespace Console\Commands: Runs built-in PHP server.
ServeDocsCommand — Class in namespace Console\Commands: Runs built-in PHP server for serving Doctum API documentation.
ServeUserGuideCommand — Class in namespace Console\Commands: Performs the command for serving the Jekyll user guide locally.
DBSeeder::seed() — Method in class DBSeeder: Runs command for seeding database.
DBSeeder::seeder() — Method in class DBSeeder: Returns a string containing contents of a new Seeder class.
Migrate::status() — Method in class Migrate: Reports migration status.
Migrate::step() — Method in class Migrate: Drops table one at a time.
$ MigrationStatus#status — Property in class MigrationStatus: Indicates either a 'Ran' or 'Pending' status.
Notifications::sendViaNotifiable() — Method in class Notifications: Deliver a notification via a notifiable (or simulate if notifiable is not an object).
Queue::shutdownSignals() — Method in class Queue: Manages shutdown signals.
Services — Class in namespace Console\Helpers: Supports commands related to Services.
Services::servicesTemplate() — Method in class Services: Template for new Service class.
Test::selectTests() — Method in class Test: Supports ability to run test by class name or function name within a class.
Test::singleFileWithinSuite() — Method in class Test: Performs testing against a single class within a test suite.
Tools::setOutput() — Method in class Tools: Enables output for symfony.
Cookie::set() — Method in class Cookie: Sets a cookie to the $_COOKIE superglobal variable. Information that it needs are its name, a value, and the amount of time we want this cookie to exist.
SessionLevelException — Class in namespace Core\Exceptions\Session: Handles exceptions related to Logger severity levels.
FormHelper::sanitize() — Method in class FormHelper: Sanitizes potentially harmful string of characters.
FormHelper::selectBlock() — Method in class FormHelper: Renders a select element with a list of options.
FormHelper::stringifyAttrs() — Method in class FormHelper: Stringify attributes.
FormHelper::submitBlock() — Method in class FormHelper: Generates a div containing an input of type submit.
FormHelper::submitTag() — Method in class FormHelper: Create a input element of type submit.
Blueprint::smallInteger() — Method in class Blueprint: Define a small integer column.
Blueprint::softDeletes() — Method in class Blueprint: Define a soft delete column.
Blueprint::string() — Method in class Blueprint: Define a string column.
Schema — Class in namespace Core\Lib\Database: The migration API that delegates table creation and modifications to the Blueprint class.
Seeder — Class in namespace Core\Lib\Database: Abstract class for seeders.
ShouldQueue — Class in namespace Core\Lib\Events\Contracts: Marker interface indicating that an event listener should be queued.
EventDispatcher::setQueueName() — Method in class EventDispatcher: Resolve the queue name for a queued listener or job.
$ UserRegistered#shouldSendEmail — Property in class UserRegistered: Flag to control if an email should be sent.
$ Uploads#sizeMsg — Property in class Uploads: Message describing maximum allowable size.
SendAccountDeactivatedEmail — Class in namespace Core\Lib\Listeners: Class for sending account deactivated E-mail.
SendPasswordResetEmail — Class in namespace Core\Lib\Listeners: Class for sending password reset E-mail.
SendPasswordUpdateEmail — Class in namespace Core\Lib\Listeners: Class for sending password updated E-mail.
SendRegistrationEmail — Class in namespace Core\Lib\Listeners: Class for sending user registered E-mail.
$ AbstractMailer#style — Property in class AbstractMailer: The style to be used with email.
AbstractMailer::send() — Method in class AbstractMailer: Send the mail
AbstractMailer::sendTo() — Method in class AbstractMailer: Statically sends E-mail
MailerService::send() — Method in class MailerService: Sends a HTML E-mail.
MailerService::sendTemplate() — Method in class MailerService: Generates E-mail using a specified template, layout, and/or css stylesheet.
MailerService::sendWithText() — Method in class MailerService: Sends a text E-mail.
DatabaseChannel::send() — Method in class DatabaseChannel: Persist the notification for the given notifiable entity.
LogChannel::send() — Method in class LogChannel: Send the given notification to the log.
MailChannel::send() — Method in class MailChannel: Deliver the notification for this channel.
MailChannel::sendWithHTML() — Method in class MailChannel: Sends notification through send function of MailerService or if text body exists it uses sendWithText.
MailChannel::sendWithCustomMailer() — Method in class MailChannel: Handle AbstractMailer subclasses.
Channel::send() — Method in class Channel: Deliver the notification for this channel.
ServiceProvider — Class in namespace Core\Lib\Providers: Abstract class for event service providers.
ApplicationTestCase::setUp() — Method in class ApplicationTestCase: Implements setUp function from TestCase class.
Arr::search() — Method in class Arr: Search for a value in an array and return the corresponding key.
Arr::set() — Method in class Arr: Set a value within an array using dot notation.
Arr::shift() — Method in class Arr: Remove and return the first element of an array.
Arr::shuffle() — Method in class Arr: Shuffle the array.
Arr::sort() — Method in class Arr: Sort an array using a callback function.
Arr::sortAssoc() — Method in class Arr: Sort an associative array by its keys.
Arr::sortBy() — Method in class Arr: Sort an array by a specific key.
Arr::sortByKeys() — Method in class Arr: Sort an array by its keys.
Arr::sortByValues() — Method in class Arr: Sort an array by its values.
Arr::swapKeys() — Method in class Arr: Swap two keys in an array.
ArraySet::search() — Method in class ArraySet: Search for a value in the array and return its key.
ArraySet::set() — Method in class ArraySet: Set a value in the array using dot notation.
ArraySet::shift() — Method in class ArraySet: Remove and return the first item from the array.
ArraySet::shuffle() — Method in class ArraySet: Shuffle the elements of the array.
ArraySet::shuffleAssociative() — Method in class ArraySet: Shuffle an array while preserving keys.
ArraySet::slice() — Method in class ArraySet: Extract a slice of the array.
ArraySet::sort() — Method in class ArraySet: Sort the array in ascending order.
ArraySet::splice() — Method in class ArraySet: Remove and replace a portion of the array.
Config::set() — Method in class Config: Set a configuration value.
Str — Class in namespace Core\Lib\Utilities: String utility class.
Str::sha1() — Method in class Str: Return the SHA1 hash of a string.
Str::shuffle() — Method in class Str: Shuffle characters in a string.
Str::similarity() — Method in class Str: Calculate similarity between two strings.
Str::snake() — Method in class Str: Convert a string to snake_case.
Str::slug() — Method in class Str: Convert a string to a URL-friendly slug.
Str::squish() — Method in class Str: Remove excessive whitespace from a string.
Str::startsWith() — Method in class Str: Determine if a string starts with a given substring.
Str::stripWhitespace() — Method in class Str: Strip all whitespace from a string.
Str::studly() — Method in class Str: Convert a string to StudlyCase (PascalCase).
Str::substr() — Method in class Str: Get a part of a string.
Str::substrCount() — Method in class Str: Count occurrences of a substring.
Str::swapKeyValue() — Method in class Str: Swap keys with values in an array and return as a string.
Model::save() — Method in class Model: Wrapper for update and insert functions. A failed form validation will cause this function to return false.
$ EmailAttachments#size — Property in class EmailAttachments: Size of the attachment.
$ ProfileImages#sort — Property in class ProfileImages: Sorted position.
Queue::setAvailableAt() — Method in class Queue: Sets when job is available.
$ UserSessions#session — Property in class UserSessions: The session.
ACLService::setAclAtRegistration() — Method in class ACLService: Sets ACL at registration. If users table is empty the default value is Admin. Otherwise, we set the value to "".
ACLService::saveACL() — Method in class ACLService: Saves ACL record.
UserService::sendWhenSetToInactive() — Method in class UserService: Sends E-mail to user when account is deactivated as appropriate.
UserService::sendWhenSetToResetPW() — Method in class UserService: Sends E-mail to user when reset_password flag is set as appropriate.
Session — Class in namespace Core: Supports functions for user sessions. This class never gets instantiated.
Session::set() — Method in class Session: Sets a value in the $_SESSION superglobal array.
SessionManager — Class in namespace Core: Supports session management
$ CustomValidator#success — Property in class CustomValidator: Flag to mark whether or not validation is successful.
SpecialCharValidator — Class in namespace Core\Validators: Child class class that supports ability to check if field contains an special character that is not a space in the field.
View::setLayout() — Method in class View: Sets the layout for the view.
View::setSiteTitle() — Method in class View: Setter function for site title of current page.
View::siteTitle() — Method in class View: Getter function for current page's site title.
View::start() — Method in class View: When called this function establishes the beginning for a section of content. Anything between calls of this function and end() will be included in our view.

T

TinkerCommand — Class in namespace Console\Commands: Supports execution for tinker command.
Migrate::tableCount() — Method in class Migrate: Determines number of tables in database before performing migration operations.
Test — Class in namespace Console\Helpers: Supports unit test related console commands.
Test::testIfExists() — Method in class Test: Checks if file exists in either test suite.
Test::testIfSame() — Method in class Test: Enforces rule that classes/files across test suites should be unique.
Test::testSuite() — Method in class Test: Run all test files in an individual test suite.
Test::testSuiteStatus() — Method in class Test: Determines if execution of a test suite(s) is successful.
Tools — Class in namespace Console\Helpers: Contains functions for miscellaneous tasks.
View::tableComponent() — Method in class View: Generates content for table component.
DB::tableExists() — Method in class DB: Checks whether a given table exists in the currently connected database.
FormHelper::telBlock() — Method in class FormHelper: Renders an HTML div element that surrounds an input of type tel.
FormHelper::textareaBlock() — Method in class FormHelper: Assists in the development of textarea in forms. It accepts parameters for setting attribute tags in the form section.
Blueprint::text() — Method in class Blueprint: Define a text column.
Blueprint::time() — Method in class Blueprint: Define a time column.
Blueprint::timestamp() — Method in class Blueprint: Define a timestamp column.
Blueprint::timestamps() — Method in class Blueprint: Define timestamps (created_at and updated_at).
Blueprint::tinyInteger() — Method in class Blueprint: Define a tiny integer column.
Schema::table() — Method in class Schema: Modify an existing table.
UserRegistered::toPayload() — Method in class UserRegistered: Adds instance variables to payload.
$ Api#timeout — Property in class Api: Connection/overall timeout in seconds.
MailerService::template() — Method in class MailerService: Prepares E-mail content based on template to be sent.
MailerService::templatePath() — Method in class MailerService: Supports ability to use alternative template paths.
Notification::toArray() — Method in class Notification: Generic array representation (fallback for logging, webhooks, etc.).
Notification::toDatabase() — Method in class Notification: Representation of the notification in the database.
Notification::toLog() — Method in class Notification: Representation of the notification in logging.
Notification::toMail() — Method in class Notification: Representation of the notification in mail.
Pagination::totalPages() — Method in class Pagination: Returns total number of pages we need to handle.
QueuedListenerJob::toPayload() — Method in class QueuedListenerJob: Converts the job into a payload array for storage in the queue.
QueueableJobInterface::toPayload() — Method in class QueueableJobInterface: Converts the job into a payload array for storage in the queue.
Vite::tags() — Method in class Vite: Render script/link tags for a Vite entry.
TestResponse — Class in namespace Core\Lib\Testing: A simplified test response wrapper that mimics HTTP-style responses for use in feature tests.
Arr::toJson() — Method in class Arr: Convert an array to a JSON string.
Arr::toObject() — Method in class Arr: Convert an array to an object.
DateTime::timeAgo() — Method in class DateTime: Accepts UTC time in format Y-m-d H:i:s and returns a string describing how much time has elapsed.
DateTime::timeDifference() — Method in class DateTime: Shows the difference between two times. An example is shown below: DateTimeHelper::timeDifference('2025-03-09 08:00:00', '2025-03-09 15:30:45'); Output: "7 hours before"
DateTime::timeStamps() — Method in class DateTime: Generates a timestamp.
DateTime::toISO8601() — Method in class DateTime: Converts to ISO 8610 format.
Str::title() — Method in class Str: Convert a string to title case.
Str::toArray() — Method in class Str: Convert a string into an array.
$ Notifications#type — Property in class Notifications: The type of notification.
DashboardService::totalUserCountExceptCurrent() — Method in class DashboardService: Returns query number of users excluding current.
UserService::toggleAccountStatus() — Method in class UserService: Assist in toggling inactive field. Returns boolean value to determine if E-mail should be sent. To properly test if E-mail should be sent get value of $user->inactive before post.
UserService::toggleResetPassword() — Method in class UserService: Assist in toggling reset_password field.
HasTimestamps::timeStamps() — Method in class HasTimestamps: Sets values for timestamp fields.

U

Model::uploadModelTemplate() — Method in class Model: The default template for a new upload model class.
Test::unitTests() — Method in class Test: Returns array containing all filenames in Unit directory.
DB::update() — Method in class DB: Performs update operation on a SQL database record.
DB::updateWhere() — Method in class DB: Updates records in a table using params-style conditions.
UnregisteredChannelException — Class in namespace Core\Exceptions\Notifications: Handles exceptions related to unregistered channels. Extends the ChannelException class.
Blueprint::unique() — Method in class Blueprint: Adds a unique index to the last defined column.
Blueprint::unsignedInteger() — Method in class Blueprint: Define an unsigned integer column (MySQL only).
Blueprint::unsignedBigInteger() — Method in class Blueprint: Define an unsigned big integer column (MySQL only).
Blueprint::update() — Method in class Blueprint: Update an existing table.
Blueprint::uuid() — Method in class Blueprint: Define a UUID column (MySQL only).
Migration::up() — Method in class Migration: Execute the migration.
$ AccountDeactivated#user — Property in class AccountDeactivated: User associated with event.
UserPasswordResetRequested — Class in namespace Core\Lib\Events: Simple DTO (Data Transfer Object) class for password reset event.
$ UserPasswordResetRequested#user — Property in class UserPasswordResetRequested: User associated with event.
UserPasswordUpdated — Class in namespace Core\Lib\Events: Simple DTO (Data Transfer Object) class for password reset event.
$ UserPasswordUpdated#user — Property in class UserPasswordUpdated: User associated with event.
UserRegistered — Class in namespace Core\Lib\Events: Simple DTO (Data Transfer Object) class for queueing new account E-mail event.
$ UserRegistered#user — Property in class UserRegistered: User associated with event.
Uploads — Class in namespace Core\Lib\FileSystem: Provides support for file uploads.
Uploads::upload() — Method in class Uploads: Performs file upload.
$ AbstractMailer#user — Property in class AbstractMailer: The user to send the email.
UpdatePasswordMailer — Class in namespace Core\Lib\Mail: Class for generating a message informing the user that their password has been updated.
Arr::unique() — Method in class Arr: Remove duplicate values from an array.
Arr::uniqueBy() — Method in class Arr: Remove duplicate items from an array based on a key or callback.
Arr::unsetKeys() — Method in class Arr: Remove multiple keys from an array.
Arr::unwrap() — Method in class Arr: Unwrap an array if it contains only one item.
ArraySet::udiff() — Method in class ArraySet: Compute the difference between arrays using a custom comparison function.
ArraySet::unique() — Method in class ArraySet: Remove duplicate values from the array.
ArraySet::usort() — Method in class ArraySet: Sort the array using a user-defined comparison function.
Str::ucfirst() — Method in class Str: Capitalize the first character of a string.
Str::ucwords() — Method in class Str: Capitalize the first letter of each word.
Str::upper() — Method in class Str: Convert a string to UPPERCASE.
Str::uuid() — Method in class Str: Generate a UUID (Universally Unique Identifier).
Model::update() — Method in class Model: Wrapper for the update function found in the DB class.
Model::updateWhere() — Method in class Model: Updates one or more rows in this model's underlying table using your framework's params-style conditions.
$ EmailAttachments#updated_at — Property in class EmailAttachments: Updated at.
$ EmailAttachments#user_id — Property in class EmailAttachments: ID of the recipient.
EmailAttachments::uploadUsername() — Method in class EmailAttachments: Retrieves username for uploader of attachment.
$ Login#username — Property in class Login: Username of authenticating user.
$ Notifications#updated_at — Property in class Notifications: Updated at.
$ ProfileImages#url — Property in class ProfileImages: The URL for the profile image.
$ ProfileImages#user_id — Property in class ProfileImages: ID of user associated with image.
ProfileImages::updateSortByUserId() — Method in class ProfileImages: Updates sort order by user id.
ProfileImages::uploadProfileImage() — Method in class ProfileImages: Performs upload operation for a profile image.
$ Queue#updated_at — Property in class Queue: Updated at.
Queue::updateAttempts() — Method in class Queue: Updates information about attempts.
UserSessions — Class in namespace Core\Models: Supports operations of the User Session model. Extends the Model class.
$ UserSessions#user_agent — Property in class UserSessions: The user agent.
$ UserSessions#user_id — Property in class UserSessions: ID of user associated with this session.
ACLService::updateUserACLs() — Method in class ACLService: Updates user's acl field
ACLService::unUsedACLs() — Method in class ACLService: Returns array of unused ACLs.
ACLService::usedACLs() — Method in class ACLService: Returns array of used ACLs.
UserService — Class in namespace Core\Services: Provides functions for managing users.
UserService::updatePassword() — Method in class UserService: Updates user's password
Session::uagent_no_version() — Method in class Session: Don't store browser version numbers so we don't break session during end user software updates.
$ HasTimestamps#updated_at — Property in class HasTimestamps: Time record was updated.
UniqueValidator — Class in namespace Core\Validators: Child class that performs validation for fields that require a unique entry in a database.
UpperCharValidator — Class in namespace Core\Validators: Child class class that supports ability to check if field contains an upper case character in the field.

V

Events::verifyListenerParams() — Method in class Events: Checks if $eventName and $listerName was provided and that they are not the same.
Validator — Class in namespace Console\Helpers: Supports operations for the make:validator command.
Validator::validatorTemplate() — Method in class Validator: Returns a string containing the structure for the new custom validator class with the name of the validator as the only parameter.
View — Class in namespace Console\Helpers: Supports ability to create views, layouts, components, and menu_acl json files.
View::viewContent() — Method in class View: Generates content for view file.
$ Controller#view — Property in class Controller: Instance of view class.
DB::valueExistsInColumn() — Method in class DB: Check if a value exists in a JSON or text-based column
ViewException — Class in namespace Core\Exceptions\View: Handles exceptions related to views/layouts. Extends the FrameworkException class.
ViewNotFoundException — Class in namespace Core\Exceptions\View: Class to handle events related to views not being found.
QueuePreferences::viaQueue() — Method in class QueuePreferences: Get the name of the queue to send the job/event listener to.
Uploads::validates() — Method in class Uploads: Reports on success of validation.
Uploads::validateFileType() — Method in class Uploads: Validates file type and sets error message if file type is invalid.
Uploads::validateSize() — Method in class Uploads: Validates file size and sets error message if file is too large.
Notification::via() — Method in class Notification: The delivery channels (e.g. ['database', 'mail']).
Vite — Class in namespace Core\Lib\React: Supports operations for Vite.
Vite::viteIsRunning() — Method in class Vite: Check if Vite dev server is reachable.
Arr::values() — Method in class Arr: Return all values from an array, resetting numeric keys.
ArraySet::values() — Method in class ArraySet: Get all values of the array.
Model::validationPassed() — Method in class Model: Getter function for the $_validates boolean instance variable.
Model::validator() — Method in class Model: Function that is called on save. If validation fails the save function will not proceed. This function is just a signature and must be implemented by models that run form validation because since it is called from within this class.
ACL::validator() — Method in class ACL: Ensures fields are required and unique.
EmailAttachments::validator() — Method in class EmailAttachments: Function that is called on save. If validation fails the save function will not proceed. This function is just a signature and must be implemented by models that run form validation because since it is called from within this class.
Login::validator() — Method in class Login: Function that is called on save. If validation fails the save function will not proceed. This function is just a signature and must be implemented by models that run form validation because since it is called from within this class.
View — Class in namespace Core: Handles operations related to views and its content.

W

Queue::worker() — Method in class Queue: Worker for queue.
Tools::writeFile() — Method in class Tools: Generates files for console commands
Api::writeCache() — Method in class Api: Persist a decoded JSON response to the cache for a given URL.
WelcomeMailer — Class in namespace Core\Lib\Mail: Class for generating a welcome message.
Arr::walkRecursive() — Method in class Arr: Recursively applies a callback function to each element in an array.
Arr::weightedRandom() — Method in class Arr: Select a random element based on weighted probabilities.
Arr::wrap() — Method in class Arr: Wrap a value in an array.
Arr::where() — Method in class Arr: Filter an array using a callback.
ArraySet::walk() — Method in class ArraySet: Apply a user function to every item in the array.
ArraySet::walkRecursive() — Method in class ArraySet: Recursively apply a user function to every item in the array.
ArraySet::wrap() — Method in class ArraySet: Wrap a value in an array if it is not already an array.
ArraySet::where() — Method in class ArraySet: Filter the array using a callback function.
Str::wordCount() — Method in class Str: Count the number of words in a string.
Str::words() — Method in class Str: Limit a string to a certain number of words.
Str::wrap() — Method in class Str: Wrap a string with a given value.
$ View#widgets — Property in class View: An array of widgets.

X

Arr::xorDiff() — Method in class Arr: Compute the exclusive difference between two arrays.

_

MigrationStatus::__construct() — Method in class MigrationStatus: Setups the MigrationStatus object
Test::__construct() — Method in class Test: Constructor
Application::__construct() — Method in class Application: Calls functions for reporting and unregister of globals.
$ Controller#_action — Property in class Controller: The name of the current action.
$ Controller#_controller — Property in class Controller: The name of the current controller.
Controller::__construct() — Method in class Controller: Constructor for the parent Controller class. This constructor gets called when an instance of the child class is instantiated.
$ DB#_count — Property in class DB: Number of items returned.
$ DB#_dbDriver — Property in class DB: The database driver.
$ DB#_error — Property in class DB: Error status.
$ DB#_fetchStyle — Property in class DB: The fetch style.
$ DB#_instance — Property in class DB: Instance of this class.
$ DB#_lastInsertID — Property in class DB: Id of last item inserted into database.
$ DB#_pdo — Property in class DB: The PDO object.
$ DB#_query — Property in class DB: The query.
$ DB#_result — Property in class DB: The result.
DB::__construct() — Method in class DB: This constructor creates a new PDO object as an instance variable. If there are any failures the application quits with an error message.
DB::_buildJoin() — Method in class DB: Constructs join statements for SQL queries.
DB::_read() — Method in class DB: Supports SELECT operations that maybe ran against a SQL database. It supports the ability to order and limit the number of results returned from a database query. The user can use parameters such as conditions, bind, order, limit, and sort.
ConsoleException::__construct() — Method in class ConsoleException: Creates new ConsoleException.
LoggerException::__construct() — Method in class LoggerException: Create a new exception to handle faults related to log file write operations.
LoggerLevelException::__construct() — Method in class LoggerLevelException: Create a new LoggerLevelException.
ChannelException::__construct() — Method in class ChannelException: Create a channel-scoped notification exception.
ChannelSendFailedException::__construct() — Method in class ChannelSendFailedException: Create an exception indicating that delivery over a specific notification channel failed. Includes contextual metadata (channel name, notification class, and notifiable id) to aid logging and retries.
SessionLevelException::__construct() — Method in class SessionLevelException: Create a new SessionLevelException.
ViewException::__construct() — Method in class ViewException: Create a new exception to handle faults related to rendering content.
Blueprint::__construct() — Method in class Blueprint: Constructor for Blueprint class.
Migration::__construct() — Method in class Migration: Creates instance of Migration class.
Seeder::__construct() — Method in class Seeder: Constructor for Seeder class. Primary role is to get DB instance.
AccountDeactivated::__construct() — Method in class AccountDeactivated: Constructor
UserPasswordResetRequested::__construct() — Method in class UserPasswordResetRequested: Constructor
UserPasswordUpdated::__construct() — Method in class UserPasswordUpdated: Constructor
UserRegistered::__construct() — Method in class UserRegistered: Constructor
$ Uploads#_bucket — Property in class Uploads: Path to the bucket where file are stored.
$ Uploads#_allowedFileTypes — Property in class Uploads: An array of allowed file types.
$ Uploads#_errors — Property in class Uploads: An array of error objects.
$ Uploads#_fieldName — Property in class Uploads: The name of the field associated with file upload.
$ Uploads#_files — Property in class Uploads: An array containing objects with information about files.
$ Uploads#_maxAllowedSize — Property in class Uploads: The maximum allowed upload size.
Uploads::__construct() — Method in class Uploads: Creates instance of Uploads class.
Api::__construct() — Method in class Api: Constructor for Api object.
AbstractMailer::__construct() — Method in class AbstractMailer: Constructor for AbstractMailer
MailerService::__construct() — Method in class MailerService: Creates a new mailer.
MailChannel::__construct() — Method in class MailChannel: Constructor for MailChannel.
Pagination::__construct() — Method in class Pagination: Constructor for Pagination class
QueuedListenerJob::__construct() — Method in class QueuedListenerJob: Construct a job from a serialized array (as provided by the worker/driver).
QueuedListenerJob::__set_state() — Method in class QueuedListenerJob: Reconstruct a job from exported state (used by var_export()).
QueueManager::__construct() — Method in class QueueManager: Constructor for QueueManager class.
RedisQueueDriver::__construct() — Method in class RedisQueueDriver: The constructor for the RedisQueueDriver.
TestResponse::__construct() — Method in class TestResponse: Constructs a new TestResponse instance.
ArraySet::__construct() — Method in class ArraySet: Constructor to initialize the array.
$ Model#_db — Property in class Model: The instance of the DB class.
$ Model#_modelName — Property in class Model: The name of the model.
$ Model#_softDelete — Property in class Model: $_softDelete value.
$ Model#_table — Property in class Model: The name of the table.
$ Model#_validates — Property in class Model: Flag to indicate if validation is successful.
$ Model#_validationErrors — Property in class Model: The array of validation errors.
Model::__construct() — Method in class Model: Default constructor.
Model::_fetchStyleParams() — Method in class Model: Used to set default fetchStyle param.
Model::_softDeleteParams() — Method in class Model: Adds to the conditions to avoid getting soft deleted rows returned
$ ACL#_softDelete — Property in class ACL: $_softDelete value.
$ ACL#_table — Property in class ACL: The name of the table.
$ EmailAttachments#_table — Property in class EmailAttachments: Set to name of database table.
$ EmailAttachments#_softDelete — Property in class EmailAttachments: Soft delete
$ EmailAttachments#_uploadPath — Property in class EmailAttachments: Set your file path. Include your bucket if necessary.
$ Login#_table — Property in class Login: Placeholder table name.
$ Notifications#_table — Property in class Notifications: The name of the notifications table.
$ ProfileImages#_softDelete — Property in class ProfileImages: Soft delete mode set to true.
$ ProfileImages#_table — Property in class ProfileImages: Name of the table.
$ ProfileImages#_uploadPath — Property in class ProfileImages: Upload path.
$ Queue#_table — Property in class Queue: Name of the table.
$ UserSessions#_table — Property in class UserSessions: The name of the table.
$ CustomValidator#_model — Property in class CustomValidator: Name of the model.
CustomValidator::__construct() — Method in class CustomValidator: Constructor for Custom Validator. It performs checks on the model and params such as fields, rules, and messages. Finally the validation is performed against input from a form. An exception is thrown if any conditions are not satisfied. When an exception is thrown a message is displayed describing the issue.
$ View#_body — Property in class View: The body
$ View#_content — Property in class View: The content
$ View#_currentBuffer — Property in class View: The content buffer
$ View#_head — Property in class View: The head
$ View#_layout — Property in class View: The layout
$ View#_outputBuffer — Property in class View: The output buffer
$ View#_siteTitle — Property in class View: The site title
View::__construct() — Method in class View: Default constructor.