Page Menu
Home
DevCentral
Search
Configure Global Search
Log In
Files
F3751783
D164.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
2 KB
Referenced Files
None
Subscribers
None
D164.diff
View Options
diff --git a/app/Phabricator/PhabricatorStory.php b/app/Phabricator/PhabricatorStory.php
--- a/app/Phabricator/PhabricatorStory.php
+++ b/app/Phabricator/PhabricatorStory.php
@@ -30,7 +30,7 @@
public $type;
/**
- * @var Array
+ * @var array
*/
public $data;
diff --git a/app/Phabricator/ProjectsMap.php b/app/Phabricator/ProjectsMap.php
--- a/app/Phabricator/ProjectsMap.php
+++ b/app/Phabricator/ProjectsMap.php
@@ -126,7 +126,7 @@
}
/**
- * Gets a new ProjectsMap instance and queries Phabricator API to fill it.
+ * Gets a new ProjectsMap instance and queries Phabricator API to fill it
*
* @param string $phabricatorURL The Phabricator URL (e.g. http://secure.phabricator.com)
* @return ProjectsMap
@@ -141,7 +141,10 @@
/// API
///
- public function fetchFromAPI () {
+ /**
+ * Fetches the projects' map from the Phabricator API
+ */
+ private function fetchFromAPI () {
$reply = PhabricatorAPI::forInstance($this->instance)->call(
'project.query',
[ 'limit' => self::LIMIT ]
@@ -175,14 +178,27 @@
return class_basename(get_class($this)) . '-' . md5($this->instance);
}
- public function isCached () {
+ /**
+ * Determines if the instance is cached
+ *
+ * @return bool true if cached; otherwise, false.
+ */
+ private function isCached () {
return Cache::has($this->getCacheKey());
}
+ /**
+ * Saves data to cache
+ */
public function saveToCache () {
Cache::forever($this->getCacheKey(), $this->map);
}
+ /**
+ * Loads data from cache
+ *
+ * Populates 'map' and 'source' properties
+ */
public function loadFromCache () {
$this->map = Cache::get($this->getCacheKey());
$this->source = 'cache';
@@ -214,7 +230,7 @@
/**
* Returns the projects map as an array, each row ['PHID', 'project name']
*
- * @return Array
+ * @return array
*/
public function toArray () {
$array = [];
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Mon, Nov 18, 12:25 (21 h, 43 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2250652
Default Alt Text
D164.diff (2 KB)
Attached To
Mode
D164: PhabricatorAPI: improve code documentation, scope review
Attached
Detach File
Event Timeline
Log In to Comment