Add PHPDoc to PhabricatorPHIDType::canLoadNamedObject()

Summary:
All implementations of `canLoadNamedObject($name)` in classes which extend `PhabricatorPHIDType` run a `preg_match()` on the `$name` parameter being passed.
Thus the parameter must always be a string.
(Spoiler: This isn't always the case currently.)

Test Plan: Read the code.

Reviewers: O1 Blessed Committers, valerio.bozzolan

Reviewed By: O1 Blessed Committers, valerio.bozzolan

Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno

Differential Revision: https://we.phorge.it/D26025

src/applications/calendar/phid/PhabricatorCalendarEventPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^E[1-9]\d*$/i', $name);
   }

src/applications/conpherence/phid/PhabricatorConpherenceThreadPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^Z\d*[1-9]\d*$/i', $name);
   }

src/applications/countdown/phid/PhabricatorCountdownCountdownPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^C\d*[1-9]\d*$/i', $name);
   }

src/applications/dashboard/phid/PhabricatorDashboardPanelPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^W\d*[1-9]\d*$/i', $name);
   }

src/applications/differential/phid/DifferentialRevisionPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^D[1-9]\d*$/i', $name);
   }

src/applications/files/phid/PhabricatorFileFilePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^F\d*[1-9]\d*$/', $name);
   }

src/applications/fund/phid/FundInitiativePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^I\d*[1-9]\d*$/i', $name);
   }

src/applications/harbormaster/phid/HarbormasterBuildablePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^B\d*[1-9]\d*$/i', $name);
   }

src/applications/herald/phid/HeraldRulePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^H\d*[1-9]\d*$/i', $name);
   }

src/applications/legalpad/phid/PhabricatorLegalpadDocumentPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^L\d*[1-9]\d*$/i', $name);
   }

src/applications/maniphest/phid/ManiphestTaskPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^T\d*[1-9]\d*$/i', $name);
   }

src/applications/owners/phid/PhabricatorOwnersPackagePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^O\d*[1-9]\d*$/i', $name);
   }

src/applications/passphrase/phid/PassphraseCredentialPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^K\d*[1-9]\d*$/i', $name);
   }

src/applications/paste/phid/PhabricatorPastePastePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^P\d*[1-9]\d*$/i', $name);
   }

src/applications/people/phid/PhabricatorPeopleUserPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^@.+/', $name);
   }

src/applications/phid/type/PhabricatorPHIDType.php

···
     array $handles,
     array $objects);
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return false;
   }

src/applications/pholio/phid/PholioMockPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^M\d*[1-9]\d*$/i', $name);
   }

src/applications/phriction/phid/PhrictionDocumentPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/.*\/$/', $name);
   }

src/applications/phurl/phid/PhabricatorPhurlURLPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^U[1-9]\d*$/i', $name);
   }

src/applications/ponder/phid/PonderQuestionPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^Q\d*[1-9]\d*$/i', $name);
   }

src/applications/project/phid/PhabricatorProjectProjectPHIDType.php

···
     return '[^\s,#]+';
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     $fragment = self::getProjectMonogramPatternFragment();
     return preg_match('/^#'.$fragment.'$/i', $name);

src/applications/repository/phid/PhabricatorRepositoryCommitPHIDType.php

···
       '[a-f0-9]{'.$min_unqualified.',40}';
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     $pattern = self::getCommitObjectNamePattern();
     return preg_match('(^'.$pattern.'$)', $name);

src/applications/repository/phid/PhabricatorRepositoryRepositoryPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^(r[A-Z]+|R[1-9]\d*)\z/', $name);
   }

src/applications/slowvote/phid/PhabricatorSlowvotePollPHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^V\d*[1-9]\d*$/i', $name);
   }

src/applications/spaces/phid/PhabricatorSpacesNamespacePHIDType.php

···
     }
   }
 
+  /**
+   * Check whether a named object is of this PHID type
+   * @param string $name Object name
+   * @return bool True if the named object is of this PHID type
+   */
   public function canLoadNamedObject($name) {
     return preg_match('/^S[1-9]\d*$/i', $name);
   }