mirror of
https://we.phorge.it/source/phorge.git
synced 2025-01-12 07:41:04 +01:00
9352c76e81
Summary: Ref T5702. This is a forward-looking change which provides some very broad API improvements but does not implement them. In particular: - Controllers no longer require `$request` to construct. This is mostly for T5702, directly, but simplifies things in general. Instead, we call `setRequest()` before using a controller. Only a small number of sites activate controllers, so this is less code overall, and more consistent with most constructors not having any parameters or effects. - `$request` now offers `getURIData($key, ...)`. This is an alternate way of accessing `$data` which is currently only available on `willProcessRequest(array $data)`. Almost all controllers which implement this method do so in order to read one or two things out of the URI data. Instead, let them just read this data directly when processing the request. - Introduce `handleRequest(AphrontRequest $request)` and deprecate (very softly) `processRequest()`. The majority of `processRequest()` calls begin `$request = $this->getRequest()`, which is avoided with the more practical signature. - Provide `getViewer()` on `$request`, and a convenience `getViewer()` on `$controller`. This fixes `$viewer = $request->getUser();` into `$viewer = $request->getViewer();`, and converts the `$request + $viewer` two-liner into a single `$this->getViewer()`. Test Plan: - Browsed around in general. - Hit special controllers (redirect, 404). - Hit AuditList controller (uses new style). Reviewers: btrahan Reviewed By: btrahan Subscribers: epriestley Maniphest Tasks: T5702 Differential Revision: https://secure.phabricator.com/D10698
103 lines
2.5 KiB
PHP
103 lines
2.5 KiB
PHP
<?php
|
|
|
|
abstract class AphrontController extends Phobject {
|
|
|
|
private $request;
|
|
private $currentApplication;
|
|
private $delegatingController;
|
|
|
|
public function setDelegatingController(
|
|
AphrontController $delegating_controller) {
|
|
$this->delegatingController = $delegating_controller;
|
|
return $this;
|
|
}
|
|
|
|
public function getDelegatingController() {
|
|
return $this->delegatingController;
|
|
}
|
|
|
|
public function willBeginExecution() {
|
|
return;
|
|
}
|
|
|
|
public function willProcessRequest(array $uri_data) {
|
|
return;
|
|
}
|
|
|
|
public function didProcessRequest($response) {
|
|
return $response;
|
|
}
|
|
|
|
public function handleRequest(AphrontRequest $request) {
|
|
if (method_exists($this, 'processRequest')) {
|
|
return $this->processRequest();
|
|
}
|
|
|
|
throw new PhutilMethodNotImplementedException(
|
|
pht(
|
|
'Controllers must implement either handleRequest() (recommended) '.
|
|
'or processRequest() (deprecated).'));
|
|
}
|
|
|
|
final public function setRequest(AphrontRequest $request) {
|
|
$this->request = $request;
|
|
return $this;
|
|
}
|
|
|
|
final public function getRequest() {
|
|
if (!$this->request) {
|
|
throw new Exception(pht('Call setRequest() before getRequest()!'));
|
|
}
|
|
return $this->request;
|
|
}
|
|
|
|
final public function getViewer() {
|
|
return $this->getRequest()->getViewer();
|
|
}
|
|
|
|
final public function delegateToController(AphrontController $controller) {
|
|
$request = $this->getRequest();
|
|
|
|
$controller->setDelegatingController($this);
|
|
$controller->setRequest($request);
|
|
|
|
$application = $this->getCurrentApplication();
|
|
if ($application) {
|
|
$controller->setCurrentApplication($application);
|
|
}
|
|
|
|
return $controller->handleRequest($request);
|
|
}
|
|
|
|
final public function setCurrentApplication(
|
|
PhabricatorApplication $current_application) {
|
|
|
|
$this->currentApplication = $current_application;
|
|
return $this;
|
|
}
|
|
|
|
final public function getCurrentApplication() {
|
|
return $this->currentApplication;
|
|
}
|
|
|
|
public function getDefaultResourceSource() {
|
|
throw new Exception(
|
|
pht(
|
|
'A Controller must implement getDefaultResourceSource() before you '.
|
|
'can invoke requireResource() or initBehavior().'));
|
|
}
|
|
|
|
public function requireResource($symbol) {
|
|
$response = CelerityAPI::getStaticResourceResponse();
|
|
$response->requireResource($symbol, $this->getDefaultResourceSource());
|
|
return $this;
|
|
}
|
|
|
|
public function initBehavior($name, $config = array()) {
|
|
Javelin::initBehavior(
|
|
$name,
|
|
$config,
|
|
$this->getDefaultResourceSource());
|
|
}
|
|
|
|
}
|