136 lines
2.6 KiB
Plaintext
136 lines
2.6 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 */
|
|
|
|
use IPS\core\AdminNotification;
|
|
use IPS\Http\Url;
|
|
use IPS\Member as MemberClass;
|
|
use function defined;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* ACP Notification Extension
|
|
*/
|
|
class {class} extends AdminNotification
|
|
{
|
|
/**
|
|
* @brief Identifier for what to group this notification type with on the settings form
|
|
*/
|
|
public static string $group = '{group}';
|
|
|
|
/**
|
|
* @brief Priority 1-5 (1 being highest) for this group compared to others
|
|
*/
|
|
public static int $groupPriority = 3;
|
|
|
|
/**
|
|
* @brief Priority 1-5 (1 being highest) for this notification type compared to others in the same group
|
|
*/
|
|
public static int $itemPriority = {priority};
|
|
|
|
/**
|
|
* Title for settings
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function settingsTitle(): string
|
|
{
|
|
return 'acp_notification_{class}';
|
|
}
|
|
|
|
/**
|
|
* Can a member access this type of notification?
|
|
*
|
|
* @param MemberClass $member The member
|
|
* @return bool
|
|
*/
|
|
public static function permissionCheck( MemberClass $member ): bool
|
|
{
|
|
return true;// $member->hasAcpRestriction( ... );
|
|
}
|
|
|
|
/**
|
|
* Is this type of notification ever optional (controls if it will be selectable as "viewable" in settings)
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function mayBeOptional(): bool
|
|
{
|
|
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|null
|
|
*/
|
|
public function body(): ?string
|
|
{
|
|
return "Body";
|
|
}
|
|
|
|
/**
|
|
* Severity
|
|
*
|
|
* @return string
|
|
*/
|
|
public function severity(): string
|
|
{
|
|
return {severity};
|
|
}
|
|
|
|
/**
|
|
* Dismissible?
|
|
*
|
|
* @return string
|
|
*/
|
|
public function dismissible(): string
|
|
{
|
|
return static::DISMISSIBLE_TEMPORARY;
|
|
}
|
|
|
|
/**
|
|
* Quick link from popup menu
|
|
*
|
|
* @return Url
|
|
*/
|
|
public function link(): Url
|
|
{
|
|
return parent::link(); // Url::internal( '...' );
|
|
}
|
|
} |