Add phpdoc
This commit is contained in:
parent
fa6c33d3ac
commit
d0c153943a
3 changed files with 32 additions and 2 deletions
|
@ -11,6 +11,11 @@ use Friendica\DI;
|
||||||
use Friendica\Model\Notify;
|
use Friendica\Model\Notify;
|
||||||
use Friendica\Network\HTTPException\ForbiddenException;
|
use Friendica\Network\HTTPException\ForbiddenException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base Module for each tab of the notification display
|
||||||
|
*
|
||||||
|
* General possibility to print it as JSON as well
|
||||||
|
*/
|
||||||
abstract class BaseNotifications extends BaseModule
|
abstract class BaseNotifications extends BaseModule
|
||||||
{
|
{
|
||||||
/** @var array Array of URL parameters */
|
/** @var array Array of URL parameters */
|
||||||
|
@ -40,9 +45,12 @@ abstract class BaseNotifications extends BaseModule
|
||||||
Notify::INTRO => 'i',
|
Notify::INTRO => 'i',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
/** @var int The default count of items per page */
|
||||||
const PER_PAGE = 20;
|
const PER_PAGE = 20;
|
||||||
|
|
||||||
|
/** @var boolean True, if ALL entries should get shown */
|
||||||
protected static $show;
|
protected static $show;
|
||||||
|
/** @var int The determined start item of the current page */
|
||||||
protected static $start;
|
protected static $start;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -62,7 +70,7 @@ abstract class BaseNotifications extends BaseModule
|
||||||
$page = ($_REQUEST['page'] ?? 0) ?: 1;
|
$page = ($_REQUEST['page'] ?? 0) ?: 1;
|
||||||
|
|
||||||
self::$start = ($page * self::PER_PAGE) - self::PER_PAGE;
|
self::$start = ($page * self::PER_PAGE) - self::PER_PAGE;
|
||||||
self::$show = ($_REQUEST['show'] ?? '') === 'all';
|
self::$show = ($_REQUEST['show'] ?? '') === 'all';
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function post(array $parameters = [])
|
public static function post(array $parameters = [])
|
||||||
|
@ -99,7 +107,19 @@ abstract class BaseNotifications extends BaseModule
|
||||||
System::jsonExit(static::getNotifies()['notifs'] ?? []);
|
System::jsonExit(static::getNotifies()['notifs'] ?? []);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function printContent(string $notif_header, array $notif_content, string $notif_nocontent, array $notif_show_lnk)
|
/**
|
||||||
|
* Shows the printable result of notifications for a specific tab
|
||||||
|
*
|
||||||
|
* @param string $notif_header The notification header
|
||||||
|
* @param array $notif_content The array with the notifications
|
||||||
|
* @param string $notif_nocontent The string in case there are no notifications
|
||||||
|
* @param array $notif_show_lnk The possible links at the top
|
||||||
|
*
|
||||||
|
* @return string The rendered output
|
||||||
|
*
|
||||||
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||||
|
*/
|
||||||
|
protected static function printContent(string $notif_header, array $notif_content, string $notif_nocontent, array $notif_show_lnk)
|
||||||
{
|
{
|
||||||
// Get the nav tabs for the notification pages
|
// Get the nav tabs for the notification pages
|
||||||
$tabs = self::getTabs();
|
$tabs = self::getTabs();
|
||||||
|
|
|
@ -10,6 +10,9 @@ use Friendica\Database\DBA;
|
||||||
use Friendica\DI;
|
use Friendica\DI;
|
||||||
use Friendica\Module\BaseNotifications;
|
use Friendica\Module\BaseNotifications;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints notifications about introduction
|
||||||
|
*/
|
||||||
class Introductions extends BaseNotifications
|
class Introductions extends BaseNotifications
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -8,6 +8,13 @@ use Friendica\Core\Renderer;
|
||||||
use Friendica\DI;
|
use Friendica\DI;
|
||||||
use Friendica\Module\BaseNotifications;
|
use Friendica\Module\BaseNotifications;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints all notification types except introduction:
|
||||||
|
* - Network
|
||||||
|
* - System
|
||||||
|
* - Personal
|
||||||
|
* - Home
|
||||||
|
*/
|
||||||
class Notifications extends BaseNotifications
|
class Notifications extends BaseNotifications
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Reference in a new issue