\APINoun
Base class for the APINouns
Synopsis
class APINoun
extends Controller
{
- // members
- protected controller $parent = NULL;
- protected DataObject $record = NULL;
- protected Member $member = NULL;
- // methods
- public void __construct()
- public void init()
- public DataObject getRecord()
- public Member getMember()
- protected SS_HTTPResponse getAPIResponse()
- protected boolean respondWithJSON()
- protected boolean respondWithText()
- protected array|null getRequestBody()
- protected SS_HTTPResponse message()
Hierarchy
Extends
- Controller
Members
protected
- $member — Member
- $parent — controller
- $record — DataObject
Methods
protected
- getAPIResponse()
- getRequestBody()
- message() — Return a simple response with a message
- respondWithJSON()
- respondWithText()
public
- __construct() — Holds the url segment for this admin
- getMember()
- getRecord()
- init() — Enable basic auth on the API