Files
IPB/applications/core/data/defaults/extensions/AdminNotifications.txt
T
2025-12-19 16:14:56 -08:00

140 lines
2.7 KiB
Plaintext

<?php
/**
* @brief ACP Notification Extension
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
{subpackage}
* @since {date}
*/
namespace IPS\{app}\extensions\core\AdminNotifications;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* ACP Notification Extension
*/
class _{class} extends \IPS\core\AdminNotification
{
/**
* @brief Identifier for what to group this notification type with on the settings form
*/
public static $group = 'other';
/**
* @brief Priority 1-5 (1 being highest) for this group compared to others
*/
public static $groupPriority = 3;
/**
* @brief Priority 1-5 (1 being highest) for this notification type compared to others in the same group
*/
public static $itemPriority = 1;
/**
* Title for settings
*
* @return string
*/
public static function settingsTitle()
{
return 'acp_notification_{class}';
}
/**
* Can a member access this type of notification?
*
* @param \IPS\Member $member The member
* @return bool
*/
public static function permissionCheck( \IPS\Member $member ): bool
{
return true;// $member->hasAcpRestriction( ... );
}
/**
* Is this type of notification ever optional (controls if it will be selectable as "viewable" in settings)
*
* @return string
*/
public static function mayBeOptional()
{
return FALSE;
}
/**
* Is this type of notification might recur (controls what options will be available for the email setting)
*
* @return bool
*/
public static function mayRecur(): bool
{
return FALSE;
}
/**
* Notification Title (full HTML, must be escaped where necessary)
*
* @return string
*/
public function title(): string
{
return "Title";
}
/**
* Notification Body (full HTML, must be escaped where necessary)
*
* @return string
*/
public function body(): string
{
return "Body";
}
/**
* Severity
*
* @return string
*/
public function severity(): string
{
return static::SEVERITY_NORMAL;
}
/**
* Dismissible?
*
* @return string
*/
public function dismissible(): string
{
return static::DISMISSIBLE_TEMPORARY;
}
/**
* Style
*
* @return bool
*/
public function style(): string
{
return static::STYLE_INFORMATION;
}
/**
* Quick link from popup menu
*
* @return \IPS\Http\Url
*/
public function link(): \IPS\Http\Url
{
return parent::link(); // \IPS\Http\Url::internal( '...' );
}
}