Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(NFC) Civi\API\Kernel - Add more docblocks #10416

Merged
merged 1 commit into from
May 25, 2017
Merged

(NFC) Civi\API\Kernel - Add more docblocks #10416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions Civi/API/Kernel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ public function runAuthorize($entity, $action, $params, $extra = NULL) {
*
* The request must be in canonical format. Exceptions will be propagated out.
*
* @param $apiRequest
* @param array $apiRequest
* @return array
* @throws \API_Exception
* @throws \Civi\API\Exception\NotImplementedException
Expand Down Expand Up @@ -200,7 +200,7 @@ public function boot($apiRequest) {
}

/**
* @param $apiRequest
* @param array $apiRequest
* @throws \API_Exception
*/
protected function validate($apiRequest) {
Expand All @@ -213,7 +213,8 @@ protected function validate($apiRequest) {
* The full description of the API request.
* @throws Exception\NotImplementedException
* @return array
* Array(0 => ProviderInterface, 1 => array).
* A tuple with the provider-object and a revised apiRequest.
* Array(0 => ProviderInterface, 1 => array $apiRequest).
*/
public function resolve($apiRequest) {
/** @var ResolveEvent $resolveEvent */
Expand Down Expand Up @@ -249,7 +250,8 @@ public function authorize($apiProvider, $apiRequest) {
* The API provider responsible for executing the request.
* @param array $apiRequest
* The full description of the API request.
* @return mixed
* @return array
* The revised API request.
*/
public function prepare($apiProvider, $apiRequest) {
/** @var PrepareEvent $event */
Expand All @@ -267,6 +269,7 @@ public function prepare($apiProvider, $apiRequest) {
* @param array $result
* The response to return to the client.
* @return mixed
* The revised $result.
*/
public function respond($apiProvider, $apiRequest, $result) {
/** @var RespondEvent $event */
Expand Down