mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
32 lines
1.1 KiB
PHP
32 lines
1.1 KiB
PHP
|
<?php namespace BookStack\Theming;
|
||
|
|
||
|
/**
|
||
|
* The ThemeEvents used within BookStack.
|
||
|
*
|
||
|
* This file details the events that BookStack may fire via the custom
|
||
|
* theme system, including event names, parameters and expected return types.
|
||
|
*
|
||
|
* This system is regarded as semi-stable.
|
||
|
* We'll look to fix issues with it or migrate old event types but
|
||
|
* events and their signatures may change in new versions of BookStack.
|
||
|
* We'd advise testing any usage of these events upon upgrade.
|
||
|
*/
|
||
|
class ThemeEvents
|
||
|
{
|
||
|
/**
|
||
|
* Application boot-up.
|
||
|
* After main services are registered.
|
||
|
* @param \BookStack\Application $app
|
||
|
*/
|
||
|
const APP_BOOT = 'app_boot';
|
||
|
|
||
|
/**
|
||
|
* Commonmark environment configure.
|
||
|
* Provides the commonmark library environment for customization
|
||
|
* before its used to render markdown content.
|
||
|
* If the listener returns a non-null value, that will be used as an environment instead.
|
||
|
* @param \League\CommonMark\ConfigurableEnvironmentInterface $environment
|
||
|
* @returns \League\CommonMark\ConfigurableEnvironmentInterface|null
|
||
|
*/
|
||
|
const COMMONMARK_ENVIRONMENT_CONFIGURE = 'commonmark_environment_configure';
|
||
|
}
|