namespace mdref;
+use IteratorAggregate;
+use function array_pop;
+use function count;
+use function ctype_lower;
+use function ctype_upper;
+use function dirname;
+use function end;
+use function explode;
+use function implode;
+use function strlen;
+use function strtr;
+use function substr;
+use function trim;
+
/**
* A single reference entry
*/
-class Entry implements \IteratorAggregate {
+class Entry implements IteratorAggregate {
/**
* Compound name
* @var string
/**
* The file path, if the refentry exists
- * @var type
+ * @var ?string
*/
private $path;
/**
* @param string $name the compound name of the ref entry, e.g. "pq/Connection/exec"
- * @param \mdref\Repo $repo the containing repository
+ * @param Repo $repo the containing repository
*/
- public function __construct($name, Repo $repo) {
+ public function __construct(string $name, Repo $repo) {
$this->repo = $repo;
$this->name = $name;
$this->list = explode("/", $name);
* Get the compound name, e.g. "pq/Connection/exec"
* @return string
*/
- public function getName() {
+ public function getName() : string {
return $this->name;
}
* Get the containing repository
* @return \mdref\Repo
*/
- public function getRepo() {
+ public function getRepo() : Repo {
return $this->repo;
}
* Get the file path, if any
* @return string
*/
- public function getPath() {
+ public function getPath() : ?string {
return $this->path;
}
/**
* Get the file instance of this entry
+ *
* @return \mdref\File
+ * @throws Exception
*/
- public function getFile() {
+ public function getFile() : File {
if (!$this->file) {
$this->file = new File($this->path);
}
* Get edit URL
* @return string
*/
- public function getEditUrl() {
+ public function getEditUrl() : string {
return $this->repo->getEditUrl($this->name);
}
/**
* Read the title of the ref entry file
+ *
* @return string
+ * @throws Exception
*/
- public function getTitle() {
+ public function getTitle() : string {
if ($this->isFile()) {
return trim($this->getFile()->readTitle());
}
}
/**
- * Read the description of the ref entry file
+ * Read the first line of the description of the ref entry file
+ *
* @return string
+ * @throws Exception
*/
- public function getDescription() {
+ public function getDescription() : string {
if ($this->isFile()) {
return trim($this->getFile()->readDescription());
}
return $this;
}
+ /**
+ * Read the full description of the ref entry file
+ *
+ * @return string
+ * @throws Exception
+ */
+ public function getFullDescription() : string {
+ if ($this->isFile()) {
+ return trim($this->getFile()->readFullDescription());
+ }
+ if ($this->isRoot()) {
+ return trim($this->repo->getRootEntry()->getFullDescription());
+ }
+ return $this;
+ }
+
/**
* Read the intriductory section of the refentry file
+ *
* @return string
+ * @throws Exception
*/
- public function getIntro() {
+ public function getIntro() : string {
if ($this->isFile()) {
return trim($this->getFile()->readIntro());
}
* Check if the refentry exists
* @return bool
*/
- public function isFile() {
+ public function isFile() : bool {
return strlen($this->path) > 0;
}
* Check if this is the first entry of the reference tree
* @return bool
*/
- public function isRoot() {
+ public function isRoot() : bool {
return count($this->list) === 1;
}
* Get the parent ref entry
* @return \mdref\Entry
*/
- public function getParent() {
+ public function getParent() : ?Entry {
switch ($dirn = dirname($this->name)) {
case ".":
case "/":
- break;
+ return null;
default:
return $this->repo->getEntry($dirn);
}
* Get the list of parents up-down
* @return array
*/
- public function getParents() {
+ public function getParents() : array {
$parents = array();
for ($parent = $this->getParent(); $parent; $parent = $parent->getParent()) {
array_unshift($parents, $parent);
* Guess whether this ref entry is about a function or method
* @return bool
*/
- public function isFunction() {
+ public function isFunction() : bool {
$base = end($this->list);
- return $base{0} === "_" || ctype_lower($base{0});
+ return $base[0] === "_" || ctype_lower($base[0]);
}
/**
* Guess whether this ref entry is about a namespace, interface or class
* @return bool
*/
- public function isNsClass() {
+ public function isNsClass() : bool {
$base = end($this->list);
- return ctype_upper($base{0});
+ return ctype_upper($base[0]);
+ }
+
+ /**
+ * @return mixed
+ */
+ public function getEntryName() {
+ return end($this->list);
+ }
+
+ /**
+ * Get namespaced name
+ * @return string
+ */
+ public function getNsName() : string {
+ if ($this->isRoot()) {
+ return $this->getName();
+ } elseif ($this->isFunction()) {
+ $parts = explode("/", trim($this->getName(), "/"));
+ $self = array_pop($parts);
+ return implode("\\", $parts) . "::" . $self;
+ } else {
+ return strtr($this->getName(), "/", "\\");
+ }
}
/**
* Display name
* @return string
*/
- public function __toString() {
+ public function __toString() : string {
$parts = explode("/", trim($this->getName(), "/"));
$myself = array_pop($parts);
if (!$parts) {
}
$parent = end($parts);
- switch ($myself{0}) {
+ switch ($myself[0]) {
case ":":
return "★" . substr($myself, 1);
default:
- if (!ctype_lower($myself{0}) || ctype_lower($parent{0})) {
+ if (!ctype_lower($myself[0]) || ctype_lower($parent[0])) {
return $myself;
}
case "_":
}
/**
- * Get the base name of this ref entry
+ * Get the dirname for child entries
* @return string
*/
- public function getBasename() {
+ public function getNextDirname() : string {
return dirname($this->path) . "/" . basename($this->path, ".md");
}
/**
* Guess whether there are any child nodes
* @param string $glob
- * @return boolean
+ * @param bool $loose
+ * @return bool
*/
- function hasIterator($glob = null, $loose = false) {
+ function hasIterator(?string $glob = null, bool $loose = false) : bool {
if (strlen($glob)) {
- return glob($this->getBasename() . "/$glob") ||
- ($loose && glob($this->getBasename() . "/*/$glob"));
+ return glob($this->getNextDirname() . "/$glob") ||
+ ($loose && glob($this->getNextDirname() . "/*/$glob"));
} elseif ($this->isRoot()) {
return true;
+ } elseif ($this->getNextDirname() !== "/") {
+ return is_dir($this->getNextDirname());
} else {
- return is_dir($this->getBasename());
+ return false;
}
}
* Guess whether there are namespace/interface/class child nodes
* @return bool
*/
- function hasNsClasses() {
+ function hasNsClasses() : bool {
return $this->hasIterator("/[A-Z]*.md", true);
}
* Guess whether there are function/method child nodes
* @return bool
*/
- function hasFunctions() {
+ function hasFunctions() : bool {
return $this->hasIterator("/[a-z_]*.md");
}
/**
- * Implements \IteratorAggregate
- * @return \mdref\Tree child nodes
+ * Implements IteratorAggregate
+ * @return Tree child nodes
+ */
+ function getIterator() : Tree {
+ return new Tree($this->getNextDirname(), $this->repo);
+ }
+
+ /**
+ * Get the structure of the refentry
+ * @return Structure
*/
- function getIterator() {
- return new Tree($this->getBasename(), $this->repo);
+ function getStructure() : Structure {
+ return new Structure($this);
}
}
projects / mdref / mdref / blobdiff