Pickles Framework Documentation

Constants
in package

Class Constants

This class defines a set of constant keys used throughout the framework for managing session data, flash messages, error handling, and request data.

Table of Contents

Constants

APP_NAME  = "app.name"
APP_VERSION  = "app.version"
AUTH_METHOD  = "auth.method"
AUTH_SESSION  = "_auth"
BOOT_PROVIDERS  = "boot"
CLI_PROVIDERS  = "cli"
DATABASE_DATABASE  = "database.database"
DATABASE_HOST  = "database.host"
DATABASE_PASSWORD  = "database.password"
DATABASE_PORT  = "database.port"
DATABASE_PROTOCOL  = "database.connection"
DATABASE_USERNAME  = "database.username"
DEFAULT_AUTH_METHOD  = "session"
DEFAULT_DATABASE_PROTOCOL  = "mysql"
DEFAULT_HASHER  = "bcrypt"
DEFAULT_SESSION_STORAGE  = "native"
DEFAULT_VIEW_ENGINE  = "pickles"
ERRORS_KEY  = "__errors"
Key used to store validation or other errors in the session.
FLASH_KEY  = "__flash__"
Key used to store flash messages in the session.
FLASH_NEW_KEY  = "__flash_new__"
Key used to store new flash messages in the session.
FLASH_OLD_KEY  = "__flash_old__"
Key used to store old flash messages in the session.
FRAMEWORK_SESSION_ID_KEY  = "__pickles_sid"
Key used to store the framework's session ID.
HASH_HASHER  = "hash.hasher"
MIGRATIONS_TABLE_NAME  = "migrations"
The name of the database table used to store migration information.
MYSQL_DATABASE_PROTOCOL  = "mysql"
OLD_DATA_KEY  = "__old_data"
Key used to store old input data from the previous request.
POSTGRES_DATABASE_PROTOCOL  = "pgsql"
PREVIOUS_REQUEST_KEY  = "__previous_request"
Key used to store data from the previous request.
RUNTIME_PROVIDERS  = "runtime"
SESSION_STORAGE  = "session.storage"
VIEW_ENGINE  = "view.engine"
Config Constants
VIEW_PATH  = "view.path"

Constants

APP_VERSION

public mixed APP_VERSION = "app.version"

AUTH_METHOD

public mixed AUTH_METHOD = "auth.method"

AUTH_SESSION

public mixed AUTH_SESSION = "_auth"

BOOT_PROVIDERS

public mixed BOOT_PROVIDERS = "boot"

CLI_PROVIDERS

public mixed CLI_PROVIDERS = "cli"

DATABASE_DATABASE

public mixed DATABASE_DATABASE = "database.database"

DATABASE_HOST

public mixed DATABASE_HOST = "database.host"

DATABASE_PASSWORD

public mixed DATABASE_PASSWORD = "database.password"

DATABASE_PORT

public mixed DATABASE_PORT = "database.port"

DATABASE_PROTOCOL

public mixed DATABASE_PROTOCOL = "database.connection"

DATABASE_USERNAME

public mixed DATABASE_USERNAME = "database.username"

DEFAULT_AUTH_METHOD

public mixed DEFAULT_AUTH_METHOD = "session"

DEFAULT_DATABASE_PROTOCOL

public mixed DEFAULT_DATABASE_PROTOCOL = "mysql"

DEFAULT_HASHER

public mixed DEFAULT_HASHER = "bcrypt"

DEFAULT_SESSION_STORAGE

public mixed DEFAULT_SESSION_STORAGE = "native"

DEFAULT_VIEW_ENGINE

public mixed DEFAULT_VIEW_ENGINE = "pickles"

ERRORS_KEY

Key used to store validation or other errors in the session.

public string ERRORS_KEY = "__errors"

FLASH_KEY

Key used to store flash messages in the session.

public string FLASH_KEY = "__flash__"

FLASH_NEW_KEY

Key used to store new flash messages in the session.

public string FLASH_NEW_KEY = "__flash_new__"

FLASH_OLD_KEY

Key used to store old flash messages in the session.

public string FLASH_OLD_KEY = "__flash_old__"

FRAMEWORK_SESSION_ID_KEY

Key used to store the framework's session ID.

public string FRAMEWORK_SESSION_ID_KEY = "__pickles_sid"

HASH_HASHER

public mixed HASH_HASHER = "hash.hasher"

MIGRATIONS_TABLE_NAME

The name of the database table used to store migration information.

public mixed MIGRATIONS_TABLE_NAME = "migrations"

This constant defines the table name where migration records are stored. It is used by the framework to track executed migrations.

MYSQL_DATABASE_PROTOCOL

public mixed MYSQL_DATABASE_PROTOCOL = "mysql"

OLD_DATA_KEY

Key used to store old input data from the previous request.

public string OLD_DATA_KEY = "__old_data"

POSTGRES_DATABASE_PROTOCOL

public mixed POSTGRES_DATABASE_PROTOCOL = "pgsql"

PREVIOUS_REQUEST_KEY

Key used to store data from the previous request.

public string PREVIOUS_REQUEST_KEY = "__previous_request"

RUNTIME_PROVIDERS

public mixed RUNTIME_PROVIDERS = "runtime"

SESSION_STORAGE

public mixed SESSION_STORAGE = "session.storage"

VIEW_ENGINE

Config Constants

public mixed VIEW_ENGINE = "view.engine"

VIEW_PATH

public mixed VIEW_PATH = "view.path" 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results