includes/api/Hook/ApiQueryBaseProcessRowHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Api\ApiQueryBase;
   6 use stdClass;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "ApiQueryBaseProcessRow" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface ApiQueryBaseProcessRowHook {
  16         /**
  17          * This hook is called for (some) API query modules as each row of the database result is
  18          * processed. An API query module wanting to use this hook should see the
  19          * ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
  20          *
  21          * @since 1.35
  22          *
  23          * @param ApiQueryBase $module Module in question
  24          * @param stdClass $row Database result row
  25          * @param array &$data Array to be included in the ApiResult
  26          * @param array &$hookData Array that was be passed to the ApiQueryBaseBeforeQuery and
  27          *   ApiQueryBaseAfterQuery hooks, intended for inter-hook communication
  28          * @return bool|void True or no return value to continue, or false to stop processing the
  29          *   result set
  30          */
  31         public function onApiQueryBaseProcessRow( $module, $row, &$data, &$hookData );
  32 }