Application
Interfaces, Classes, Traits and Enums
- FormattableEntityInterface
- Common interface for all entities that implement the format method
- AuthenticationChecker
- Helper class to check whether users are allowed to execute the request
- CurrentUser
- Small helper class for the currently logged-in user
- AbstractCommand
- This is the base class for all commands, the cli executor expects all commands to extend this class and have a JinyaCommand attribute
- FileCacheCommand
- This command generates the file cache of uploaded images
- JinyaCommand
- This attribute marks a class that extends AbstractCommand as an executable command for the CLI
- MigrationCommand
- This command migrates the Jinya CMS database to the most recent version
- ThemeActivateCommand
- This is the base class for all commands, the cli executor expects all commands to extend this class and have a JinyaCommand attribute
- ThemeCompileCommand
- This is the base class for all commands, the cli executor expects all commands to extend this class and have a JinyaCommand attribute
- ThemeSyncCommand
- This is the base class for all commands, the cli executor expects all commands to extend this class and have a JinyaCommand attribute
- DatabaseAnalyzer
- This class analyzes the database and allows to retrieve several database information
- QueryAnalyzer
- Helper class to wrap phpmyadmin SQL parser
- ApiKey
- This class contains an api key, used to log in to Jinya CMS api
- Artist
- This class contains all information relevant for an artist. Artists are the users of Jinya CMS
- BlogCategory
- This class contains a blog category, blog categories can have child categories and have blog posts.
- BlogPost
- This class contains the information of a blog post
- BlogPostSegment
- This class contains a part of a blog post. A blog post consists of several segments.
- DeleteLastAdminException
- This exception gets thrown when an attempt is made to delete the last admin
- EmptyResultException
- This exception gets thrown when the result is empty, but was excepted to contain data
- ForeignKeyFailedException
- This exception is thrown when a foreign key constraint fails during deletion or creation
- TransactionFailedException
- This exception is thrown when a transaction fails to create
- UniqueFailedException
- This exception is thrown when a unique constraint fails
- File
- This class contains information about files stored with the media manager in Jinya CMS
- FileTag
- This class contains information about the tags of files
- Form
- This class contains a form, forms allow artists to receive feedback from their site visitors
- FormItem
- This class contains a form item, a form has several items
- Gallery
- This class contains a gallery, galleries are used to arrange files in a list or masonry layout and horizontal or vertical orientation. They can be embedded into segment pages and blog posts
- GalleryFilePosition
- This class is a mapper class to combine galleries and files, while maintaining a position the file is placed at in the gallery
- KnownDevice
- This class contains a known device, known devices are used to remove the need for a two-factor code. It is up to the API consumer whether they want to use them or not.
- Menu
- This class contains a menu, menus contain menu items, which are used to create the navigation in themes
- MenuItem
- This class contains a menu item. A menu item is a class containing information about an entry in a menu.
- Migrator
- Abstract static class to migrate the Jinya database to the most recent state
- Segment
- This class contains a segment of segment pages. Segments can contain different kinds of data, currently supported are galleries, forms, files and static HTML content. If the data is a file it is also possible to specify an action which can be either script or link. Depending on the action the fields have to be set accordingly.
- SegmentPage
- This class contains information about segment pages
- SimplePage
- This class contains a simple page. Simple pages only contain HTML content and a title
- JsonStrategy
- Laminas hydrator strategy to serialize and deserialize JSON data
- NullableBooleanStrategy
- Laminas hydrator strategy to convert nullable booleans between PHP and MySQL
- PhpSerializeStrategy
- Laminas hydrator strategy to serialize and deserialize PHP data with serialize method
- ThemeDescriptionStrategy
- Laminas hydrator strategy to serialize and deserialize theme descriptions
- Theme
- This class contains all information for themes that are stored in the database. Apart from the database side there are also filesystem theme information.
- ThemeAsset
- The ThemeHelperEntity adds several additional helper methods specifically for the the entities
- ThemeBlogCategory
- This class contains a blog category connected to a theme
- ThemeFile
- This class contains a file connected to a theme
- ThemeForm
- This class contains a form connected to a theme
- ThemeGallery
- This class contains a gallery connected to a theme
- ThemeMenu
- This class contains a menu connected to a theme
- ThemePage
- This class contains a simple page connected to a theme
- ThemeSegmentPage
- This class contains a segment page connected to a theme
- UploadingFile
- This class contains and uploading file. Uploading files are temporary entities used to handle the chunked upload feature of Jinya CMS
- UploadingFileChunk
- This class contains a chunk of an uploading file
- LoadableEntity
- Base class for all entity classes. this class contains several helper methods and provides a common interface for all entities.
- RearrangableEntity
- Base class for all entities that need the ability to rearrange themselves in their parent
- SkipFieldFilter
- A simple laminas hydrator filter to skip properties during hydration and dehydration
- ThemeHelperEntity
- The ThemeHelperEntity adds several additional helper methods specifically for the the entities
- Logger
- Simple factory class to create a PSR-3 logger
- MailerFactory
- A simple factory class to create a new PHPMailer instance
- NewLoginMail
- This class is the new login mail and should be sent when a new login was registered
- NewSavedDeviceMail
- This class is the new saved device mail and should be sent when a new saved device was registered
- TwoFactorMail
- This class is the two-factor mail and should be sent when a two-factor code was requested
- IniValue
- This class contains a PHP INI value
- PhpExtension
- This class contains information about a PHP extension
- PhpInfoService
- FormMessageHandler
- The form message handler, handles the data from form posts and send the mail to the configured to address
- JinyaApi
- This attribute is used to make an entity class routable and available via the REST API
- JinyaApiField
- Specifies whether a field in a JinyaApi entity is required or ignored
- JinyaModelToRouteResolver
- This class checks the database namespace and generates the CRUD endpoints for the Jinya api. The endpoints are auto generated based on the JinyaApi attribute
- Entity
- Helper class to get the share of entities in the database
- History
- Helper class to get the history of the given entity type
- HistoryEntry
- A history entry contains the count and date of changes
- MatomoClient
- The matomo client connects to the configured matomo instance and offers a few statistics methods
- Storage
- Helper class to get storage statistics
- FileUploadService
- A simple helper to handle file uploads
- ProfilePictureService
- A simple helper to handle profile picture uploads
- StorageBaseService
- Provides helpers for storage services. It contains several constants and a helper method for hashing files
- DatabaseAwareTestCase
- Extension
- DropAllTablesSubscriber
- MigrationSubscriber
- FrontTestCase
- TestRequestHandler
- ThemeActionTestCase
- ThemeTestCase
- Engine
- Helper class to create a new Plates engine
- FileExtension
- Provides extensions to the Plates engine, adding helper methods for image handling of files
- LinksExtension
- Provides extensions to the Plates engine, adding helper methods for handling of configuration links
- MenuExtension
- Provides extensions to the Plates engine, adding helper methods for menus
- ThemeExtension
- Provides extensions to the Plates engine, adding helper methods for themes
- Theme
- Themes contain all information about the cache state and several helpers for themes
- ThemeSyncer
- Helper class to synchronise the themes in the file system with the database
- AppSettingsInitializer
- Initializes all environment variables from .env
- UuidGenerator
- Helper class to generate UUIDs
- Action
- Base class for all http actions that can't be generated with reflection
- DeleteApiKeyAction
- Action to delete an api key
- ListAllApiKeysAction
- Action to list api keys
- ActivateArtistAction
- Action to activate an artist
- CreateArtistAction
- Action to activate an artist
- DeactivateArtistAction
- Action to deactivate an artist
- DeleteProfilePictureAction
- Action to delete the profile picture
- GetProfilePictureAction
- Action to get the profile picture
- UploadProfilePictureAction
- Action to upload a new profile picture
- UpdateArtistAction
- Action to activate an artist
- ChangePasswordAction
- Action to change the password
- LoginAction
- Action for login
- TwoFactorAction
- Action for two-factor login
- BatchSegmentsAction
- Action to batch replace blog post segments
- GetSegmentsAction
- Action to get segments
- ListPostsByCategoryAction
- Action to list posts by category
- DatabaseAnalyzerAction
- Action to analyse the database
- ExecuteQueryAction
- Action to execute a query
- GetEnvironmentAction
- Action to get the env variables
- GetFileContentAction
- Action to get the content of a file
- FinishUploadAction
- Action to finalise a file upload
- StartUploadAction
- Action to initialize an upload
- UploadChunkAction
- Action to upload a chunk
- CreateFormItemAction
- Action to create a form item
- DeleteFormItemAction
- Action to delete a form item
- GetFormItemsAction
- Action to get form items of a form
- UpdateFormItemAction
- Action to update form items
- FrontAction
- The base action for all front actions
- GetBlogFrontAction
- Action to show blog frontend
- GetFrontAction
- Action to get the frontend
- GetFrontLinksAction
- The base action for all front actions
- PostFrontAction
- Action to post the forms
- CreatePositionAction
- Action to create gallery positions
- DeletePositionAction
- Action to delete a position
- GetPositionsAction
- Action to get all positions
- UpdatePositionAction
- Action to update a position
- GetInstallerAction
- Action to show the installer page
- InstallAction
- Base installer action
- PostInstallerAction
- Action to post the installer
- DeleteKnownDeviceAction
- Action to delete a known device
- ListAllKnownDevicesAction
- Action to list all known devices for the current user
- ValidateKnownDeviceAction
- Action to validate a known device
- LocatorAction
- Action to locate an IP with freegeoip.app
- CreateMenuItemByMenuAction
- Action to create a menu item with menu as parent
- CreateMenuItemByMenuItemAction
- Action to create a menu item with menu item as parent
- DeleteMenuItemAction
- Action to delete a menu item
- GetMenuItemsByMenuAction
- Action to get menu items by menu
- MenuItemAction
- Base action for menu items
- MoveMenuItemParentToItemAction
- Action to move a menu item to a new parent
- ResetMenuItemParentAction
- Action to set the menu item parent to the menu
- UpdateMenuItemAction
- Action to update a menu item excluding its parent
- GetArtistInfoAction
- Action to get info about current artist
- UpdateAboutMeAction
- Action to update the about me section the current artist
- UpdateColorSchemeAction
- Action to change the color scheme of the artist
- GetFullPhpInfoAction
- Action to grab all information available from phpinfo
- GetPhpInfoAction
- Action to grab several PHP information
- CreateFileSegmentAction
- Action to create a file segment
- CreateFormSegmentAction
- Action to create a form segment
- CreateGallerySegmentAction
- Action to create a gallery segment
- CreateHtmlSegmentAction
- Action to create an HTML segment
- DeleteSegmentAction
- Action to delete a segment
- GetSegmentsAction
- Action to get all segments
- UpdateSegmentAction
- Action to update a segment
- GetEntityStatisticsAction
- Action to get entity share in Jinya CMS
- GetHistoryStatisticsAction
- Action to get history statistics
- GetSystemStatisticsAction
- Action to get the system storage stats
- GetVisitsByBrowserAction
- Action to get visits by browser from matomo
- GetVisitsByCountryAction
- Action to get visits by country from matomo
- GetVisitsByDeviceBrandAction
- Action to get visits by device brand from matomo
- GetVisitsByDeviceTypeAction
- Action to get visits by device type from matomo
- GetVisitsByLanguageAction
- Action to get visits by language from matomo
- GetVisitsByOsAction
- Action to get visits by os version from matomo
- GetVisitsByReferrerAction
- Action to get visits by referrer from matomo
- ActivateThemeAction
- Action to activate a theme
- CompileThemeAction
- Action to compile theme assets
- CreateThemeAction
- Action to upload a theme
- GetConfigurationStructureAction
- Action to get the configuration structure
- GetDefaultConfigurationValuesAction
- Action to get the default configuration values
- GetLinkItemAction
- Action to get the links by entity type
- GetPreviewImageAction
- Action to get the theme preview image
- GetStyleVariablesAction
- Action to get all style variables
- PutConfigurationAction
- Action to update the configuration
- PutLinkItemAction
- Action to update a theme link
- PutStyleVariablesAction
- Action to update the SCSS variables
- ThemeAction
- The base theme action
- UpdateThemeFilesAction
- Action to update a theme
- ApiUpdateAction
- Base action for updates
- GetUpdateAction
- Action to get the update UI
- InitUpdateProcessAction
- Action to set the update cookie
- PostUpdateAction
- Action to post the update
- UpdateAction
- Base action for updates
- GetVersionInfo
- Action to get version info
- BadCredentialsException
- This exception is thrown when the credentials are invalid, cause either username and password don't match or the api key is invalid
- ConflictException
- This exception is thrown when a conflict arises, a common example is failed unique and foreign key constraints
- MissingFieldsException
- This exception is thrown when a create request has missing fields
- NoResultException
- This exception is thrown, when the requested entity is not found in the database
- UnknownDeviceException
- This exception is thrown, when the device code used to bypass two-factor auth is unknown or not valid for the user
- HttpErrorHandler
- A Slim error handler to respond if the request fails a specialized JSON error
- AuthorizationMiddleware
- The authorization middleware checks the authorization and sets the currently logged in user
- CheckRequiredFieldsMiddleware
- Middleware to check for required fields in the parsed body
- CheckRouteInCurrentThemeMiddleware
- Middleware to check if the current route is in any configured menu for the current theme
- VariablesType
- Declares the different variable types available in MySQL, MariaDB, Percona etc.
- ImageType
- Helper enum to differentiate between image file types