mirror of https://github.com/friendica/friendica
76 lines
1.8 KiB
PHP
76 lines
1.8 KiB
PHP
<?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()
|
|
*/
|
|
public function init();
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public function rawContent();
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public function content(): string;
|
|
|
|
/**
|
|
* Module DELETE method to process submitted data
|
|
*
|
|
* Extend this method if the module is supposed to process DELETE requests.
|
|
* Doesn't display any content
|
|
*/
|
|
public function delete();
|
|
|
|
/**
|
|
* Module PATCH method to process submitted data
|
|
*
|
|
* Extend this method if the module is supposed to process PATCH requests.
|
|
* Doesn't display any content
|
|
*/
|
|
public function patch();
|
|
|
|
/**
|
|
* Module POST method to process submitted data
|
|
*
|
|
* Extend this method if the module is supposed to process POST requests.
|
|
* Doesn't display any content
|
|
*/
|
|
public function post();
|
|
|
|
/**
|
|
* Called after post()
|
|
*
|
|
* Unknown purpose
|
|
*/
|
|
public function afterpost();
|
|
|
|
/**
|
|
* Module PUT method to process submitted data
|
|
*
|
|
* Extend this method if the module is supposed to process PUT requests.
|
|
* Doesn't display any content
|
|
*/
|
|
public function put();
|
|
|
|
public function getClassName(): string;
|
|
}
|