Differential D14032 Diff 33925 src/aphront/interface/AphrontResponseProducerInterface.php

Changeset View

Standalone View

				<?php

				/**
				* An object can implement this interface to allow it to be returned directly
				* from an @{class:AphrontController}.
				*
				* Normally, controllers must return an @{class:AphrontResponse}. Sometimes,
				* this is not convenient or requires an awkward API. If it's preferable to
				* return some other type of object which is equivalent to or describes a
				* valid response, that object can implement this interface and produce a
				* response later.
				*/
				interface AphrontResponseProducerInterface {

				joshuaspenceUnsubmitted Not Done Inline Actions Personally I feel that naming an interface with `Interface` is odd. joshuaspence: Personally I feel that naming an interface with `Interface` is odd.

				/**
				* Produce the equivalent @{class:AphrontResponse} for this object.
				*
				* @return AphrontResponse Equivalent response.
				*/
				public function produceAphrontResponse();


				}