Handler.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest;
 
use MediaWiki\Rest\Validator\BodyValidator;
use MediaWiki\Rest\Validator\NullBodyValidator;
use MediaWiki\Rest\Validator\Validator;
 
abstract class Handler {
 
    const PARAM_SOURCE = 'rest-param-source';
 
    private $router;
 
    private $request;
 
    private $config;
 
    private $responseFactory;
 
    private $validatedParams;
 
    private $validatedBody;
 
    public function init( Router $router, RequestInterface $request, array $config,
        ResponseFactory $responseFactory
    ) {
        $this->router = $router;
        $this->request = $request;
        $this->config = $config;
        $this->responseFactory = $responseFactory;
    }
 
    protected function getRouter(): Router {
        return $this->router;
    }
 
    public function getRequest(): RequestInterface {
        return $this->request;
    }
 
    public function getConfig(): array {
        return $this->config;
    }
 
    public function getResponseFactory(): ResponseFactory {
        return $this->responseFactory;
    }
 
    public function validate( Validator $restValidator ) {
        $validatedParams = $restValidator->validateParams( $this->getParamSettings() );
        $validatedBody = $restValidator->validateBody( $this->request, $this );
        $this->validatedParams = $validatedParams;
        $this->validatedBody = $validatedBody;
    }
 
    public function getParamSettings() {
        return [];
    }
 
    public function getBodyValidator( $contentType ) {
        return new NullBodyValidator();
    }
 
    public function getValidatedParams() {
        return $this->validatedParams;
    }
 
    public function getValidatedBody() {
        return $this->validatedBody;
    }
 
    protected function getLastModified() {
        return null;
    }
 
    protected function getETag() {
        return null;
    }
 
    public function needsReadAccess() {
        return true;
    }
 
    public function needsWriteAccess() {
        return true;
    }
 
    abstract public function execute();
}