X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=mdref%2FFile.php;h=3c1ca0a6d276e37314178606f336d595ad3137c2;hb=33d1f049c4cdd3fa2bf4437875685d819e35fff4;hp=48d53c44150e12acff06b522073ecceeb902645d;hpb=30ba41f956001432d6f07a23794d8e34248b3f7c;p=mdref%2Fmdref

diff --git a/mdref/File.php b/mdref/File.php
index 48d53c4..3c1ca0a 100644
--- a/mdref/File.php
+++ b/mdref/File.php
@@ -2,6 +2,14 @@
 
 namespace mdref;
 
+use function feof;
+use function fgets;
+use function fopen;
+use function fseek;
+use function strncmp;
+use function substr;
+use const SEEK_SET;
+
 /**
  * A ref entry file
  */
@@ -13,42 +21,56 @@ class File {
 
 	/**
 	 * Open the file
+	 *
 	 * @param string $path
+	 * @throws Exception
 	 */
-	public function __construct($path) {
-		$this->fd = fopen($path, "rb");
+	public function __construct(string $path) {
+		if (!$this->fd = fopen($path, "rb")) {
+			throw Exception::fromLastError();
+		}
 	}
 
 	/**
 	 * Read the title of the refentry
+	 *
 	 * @return string
+	 * @throws Exception
 	 */
-	public function readTitle() {
+	public function readTitle() : string {
 		if ($this->rewind(1)) {
 			return fgets($this->fd);
 		}
+		throw Exception::fromLastError();
 	}
 
 	/**
 	 * Read the description (first line) of the refentry
+	 *
 	 * @return string
+	 * @throws Exception
 	 */
-	public function readDescription() {
-		if ($this->rewind()
-		&& (false !== fgets($this->fd))
+	public function readDescription() : ?string {
+		if (!$this->rewind()) {
+			throw Exception::fromLastError();
+		}
+		if (false !== fgets($this->fd)
 		&& (false !== fgets($this->fd))) {
 			return fgets($this->fd);
 		}
+		return null;
 	}
 
 	/**
 	 * Read the full description (first section) of the refentry
+	 *
 	 * @return string
+	 * @throws Exception
 	 */
-	public function readFullDescription() {
+	public function readFullDescription() : ?string {
 		$desc = $this->readDescription();
 		while (false !== ($line = fgets($this->fd))) {
-			if ($line{0} === "#") {
+			if ($line[0] === "#") {
 				break;
 			} else {
 				$desc .= $line;
@@ -61,7 +83,7 @@ class File {
 	 * Read the first subsection of a global refentry
 	 * @return string
 	 */
-	public function readIntro() {
+	public function readIntro() : string {
 		$intro = "";
 		if ($this->rewind()) {
 			$header = false;
@@ -87,7 +109,13 @@ class File {
 		return $intro;
 	}
 
-	public function readSection($title) {
+	/**
+	 * Read section of $title
+	 *
+	 * @param $title
+	 * @return string
+	 */
+	public function readSection(string $title) : string {
 		$section = "";
 		if ($this->rewind()) {
 			while (!feof($this->fd)) {
@@ -111,11 +139,20 @@ class File {
 		return $section;
 	}
 
-	private function rewind($offset = 0) {
+	/**
+	 * @param int $offset
+	 * @return bool
+	 */
+	private function rewind(int $offset = 0) : bool {
 		return 0 === fseek($this->fd, $offset, SEEK_SET);
 	}
 
-	private function isHeading($line, $title = null) {
+	/**
+	 * @param string $line
+	 * @param string $title
+	 * @return bool
+	 */
+	private function isHeading(string $line, ?string $title = null) : bool {
 		if ("## " !== substr($line, 0, 3)) {
 			return false;
 		}