Application
Table of Contents
Interfaces
- Configurable
- An interface defining a Configurable class
- Configuration
- An interface defining a Configuration
- Controller
- An interface defining a Controller
- DataRepository
- An interface defining a DataRepository
DataRepositories are utilized to perform CRUD actions on data stores
- Entity
- EntityRepository
- File
- Loader
- Loaders are the primary engine of applications
They marshall all of the different components of the app stack, resulting in the rendered content seen by the user.
- Logger
- An interface defining a Logger
- PageableDataRepository
- An interface defining a DataRepository with Pageable result sets
DataRepositories are utilized to perform CRUD actions on data stores
- Site
- An interface defining a Site
Sites provide a single, unified application context throughout the execution of the application, providing state information to components, and allowing them to alter the flow of the application without
direct knowledge of the inner workings of the other components.
- SitePage
- An interface defining a SitePage
SitePages are used to define metadata like subaction options, titles and user security levels
- SystemMessage
- SystemMessage is used to provide UI updates to users.
- User
- An interface defining a User
Pipit Core doesn't really need to know anything specific about a User class beyond its existence, but defining this interface helps guarantee consistency between client app User implementations.
- ViewRenderer
- An interface defining a ViewRenderer
ViewRenderers are utilized by controllers and handle the presentation of data to the user
Built in implementations are HTMLViewRenderer and JSONViewRenderer
Classes
- AbstractConfiguration
- An abstract implementation of the Configuration class
- DynamicDatabaseRepositoryConfiguration
- A Configuration class representing a DynamicDatabaseRepository configuration
- AbstractController
- An abstract implementation of the Controller interface, intended to be extended by App controllers
- CoreObject
- A base class for many Core classes to provide shared access to resources and common functions
- AbstractDataBaseRepository
- An abstract implementation of the DataBaseRepository interface
Extending this provides CRUD interaction with the configured database table
- AbstractPageableDatabaseRepository
- A Pageable implementation of the DataBaseRepository interface
Extending this provides Pageable CRUD interaction with the configured database table
- AbstractUser
- Represents the application user
Handles session management, authentication, and authorization
- DBInstance
- Provides a PDO DB connection to instances of \Pipit\Classes\Data\DBObject and its descendants
- DBObject
- A base class to be extended by any class that needs to access the DB
Provides a DB connection instance and several abstractions for DB interaction
- DynamicDataBaseRepository
- A basic DB Repository class providing generic CRUD interaction with the configured database table
- ResultsPage
- Represents a Page of DataRepository results
- SimpleFile
- Represents a file entry
- UserCAS
- Represents the application user
Handles session management, authentication through CAS, and authorization
- UserDB
- Represents the application user
Handles session management, authentication, and authorization
- UserSAML
- Represents the application user
Handles session management, authentication, and authorization
- ConfigurationException
- AbstractHelper
- A base class for many Core classes to provide shared access to resources and common functions
- FileManager
- A base class for many Core classes to provide shared access to resources and common functions
- CoreLoader
- The CoreLoader is the default implementation of the Loader interface.
- CoreLogger
- The default implementation of the Logger interface.
- LoggerLevel
- A helper class for CoreLogger that defines how a CoreLogger log level corresponds to a PHP error code.
- AbstractSite
- An abstract implementation of the Site interface
- AbstractSitePage
- An abstract implementation of a SitePage
SitePages are used to define metadata like subaction options, titles and user security levels
- CoreSite
- The primary site manager
- CoreSitePage
- The app level implementation of a SitePage
SitePages are used to define metadata like subaction options, titles and user security levels
- CoreSystemMessage
- The default implementation of the SystemMessage interface
- CSVViewRenderer
- An implementation of the ViewRenderer interface for rendering registered viewvariables as CSV
- HTMLViewRenderer
- The default implementation of the ViewRenderer interface.
- JSONViewRenderer
- An implementation of the ViewRenderer interface for rendering registered viewvariables as JSON
- CoreAutoload
- A fallback autoloader to use when not using Composer's autoloaders
- CoreFunctions
- A library class that provides shared access to resources and common functions
- LDAPConnector
Traits
- FileConfiguration