2021-11-14 20:28:36 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Capabilities;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This interface provides the capability to handle requests from clients and returns the desired outcome
|
|
|
|
*/
|
|
|
|
interface ICanHandleRequests
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Initialization method common to both content() and post()
|
|
|
|
*
|
|
|
|
* Extend this method if you need to do any shared processing before both
|
|
|
|
* content() or post()
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function init();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module GET method to display raw content from technical endpoints
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to return communication data,
|
|
|
|
* e.g. from protocol implementations.
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function rawContent();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module GET method to display any content
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to return any display
|
|
|
|
* through a GET request. It can be an HTML page through templating or a
|
|
|
|
* XML feed or a JSON output.
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function content();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module DELETE method to process submitted data
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to process DELETE requests.
|
|
|
|
* Doesn't display any content
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function delete();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module PATCH method to process submitted data
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to process PATCH requests.
|
|
|
|
* Doesn't display any content
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function patch();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module POST method to process submitted data
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to process POST requests.
|
|
|
|
* Doesn't display any content
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function post();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called after post()
|
|
|
|
*
|
|
|
|
* Unknown purpose
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function afterpost();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Module PUT method to process submitted data
|
|
|
|
*
|
|
|
|
* Extend this method if the module is supposed to process PUT requests.
|
|
|
|
* Doesn't display any content
|
|
|
|
*/
|
2021-11-14 20:46:25 +01:00
|
|
|
public static function put();
|
2021-11-14 20:28:36 +01:00
|
|
|
|
|
|
|
public static function getClassName(): string;
|
|
|
|
}
|