src/applications/phid/handle/pool/PhabricatorHandlePool.php

   1 <?php
   2
   3 /**
   4  * Coordinates loading object handles.
   5  *
   6  * This is a low-level piece of plumbing which code will not normally interact
   7  * with directly. For discussion of the handle pool mechanism, see
   8  * @{class:PhabricatorHandleList}.
   9  */
  10 final class PhabricatorHandlePool extends Phobject {
  11
  12   private $viewer;
  13   private $handles = array();
  14   private $unloadedPHIDs = array();
  15
  16   public function setViewer(PhabricatorUser $user) {
  17     $this->viewer = $user;
  18     return $this;
  19   }
  20
  21   public function getViewer() {
  22     return $this->viewer;
  23   }
  24
  25   public function newHandleList(array $phids) {
  26     // Mark any PHIDs we haven't loaded yet as unloaded. This will let us bulk
  27     // load them later.
  28     foreach ($phids as $phid) {
  29       if (empty($this->handles[$phid])) {
  30         $this->unloadedPHIDs[$phid] = true;
  31       }
  32     }
  33
  34     $unique = array();
  35     foreach ($phids as $phid) {
  36       $unique[$phid] = $phid;
  37     }
  38
  39     return id(new PhabricatorHandleList())
  40       ->setHandlePool($this)
  41       ->setPHIDs(array_values($unique));
  42   }
  43
  44   public function loadPHIDs(array $phids) {
  45     $need = array();
  46     foreach ($phids as $phid) {
  47       if (empty($this->handles[$phid])) {
  48         $need[$phid] = true;
  49       }
  50     }
  51
  52     foreach ($need as $phid => $ignored) {
  53       if (empty($this->unloadedPHIDs[$phid])) {
  54         throw new Exception(
  55           pht(
  56             'Attempting to load PHID "%s", but it was not requested by any '.
  57             'handle list.',
  58             $phid));
  59       }
  60     }
  61
  62     // If we need any handles, bulk load everything in the queue.
  63     if ($need) {
  64       // Clear the list of PHIDs that need to be loaded before performing the
  65       // actual fetch. This prevents us from looping if we need to reenter the
  66       // HandlePool while loading handles.
  67       $fetch_phids = array_keys($this->unloadedPHIDs);
  68       $this->unloadedPHIDs = array();
  69
  70       $handles = id(new PhabricatorHandleQuery())
  71         ->setViewer($this->getViewer())
  72         ->withPHIDs($fetch_phids)
  73         ->execute();
  74       $this->handles += $handles;
  75     }
  76
  77     return array_select_keys($this->handles, $phids);
  78   }
  79
  80 }