WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/objectTypes/aid/OIDplusAid.class.php

 // phpcs:enable PSR1.Files.SideEffects
 class OIDplusAid extends OIDplusObject {
         private $aid;
+        /**
+         * @param $aid
+         */
         public function __construct($aid) {
                 // TODO: syntax checks
                 $this->aid = $aid;
+        }
+        /**
+         * @param string $node_id
+         * @return OIDplusAid|null
+         */
-        public static function parse($node_id) {
+        public static function parse(string $node_id)/*: ?OIDplusAid*/ {
                 @list($namespace, $aid) = explode(':', $node_id, 2);
-                if ($namespace !== self::ns()) return false;
+                if ($namespace !== self::ns()) return null;
                 return new self($aid);
+        }
+        /**
+         * @return string
+         */
-        public static function objectTypeTitle() {
+        public static function objectTypeTitle(): string {
                 return _L('Application Identifier (ISO/IEC 7816)');
+        }
+        /**
+         * @return string
+         */
-        public static function objectTypeTitleShort() {
+        public static function objectTypeTitleShort(): string {
                 return _L('AID');
+        }
+        /**
+         * @return string
+         */
-        public static function ns() {
+        public static function ns(): string {
                 return 'aid';
+        }
+        /**
+         * @return string
+         */
-        public static function root() {
+        public static function root(): string {
                 return self::ns().':';
+        }
+        /**
+         * @return bool
+         */
-        public function isRoot() {
+        public function isRoot(): bool {
                 return $this->aid == '';
+        }
+        /**
+         * @param bool $with_ns
+         * @return string
+         */
-        public function nodeId($with_ns=true) {
+        public function nodeId(bool $with_ns=true): string {
                 return $with_ns ? self::root().$this->aid : $this->aid;
+        }
+        /**
+         * @param string $str
+         * @return string
+         * @throws OIDplusException
+         */
-        public function addString($str) {
+        public function addString(string $str): string {
                 $m = array();
                 $str = str_replace(' ','',$str);
                 $str = str_replace(':','',$str);
                 */
                 return $this->nodeId(true).strtoupper($str);
+        }
+        /**
+         * @param OIDplusObject $parent
+         * @return string
+         */
-        public function crudShowId(OIDplusObject $parent) {
+        public function crudShowId(OIDplusObject $parent): string {
                 return $this->chunkedNotation(false);
+        }
+        /**
+         * @return string
+         */
-        public function crudInsertPrefix() {
+        public function crudInsertPrefix(): string {
                 return $this->isRoot() ? '' : $this->chunkedNotation(false);
+        }
+        /**
+         * @param OIDplusObject|null $parent
+         * @return string
+         */
-        public function jsTreeNodeName(OIDplusObject $parent = null) {
+        public function jsTreeNodeName(OIDplusObject $parent = null): string {
                 if ($parent == null) return $this->objectTypeTitle();
                 return substr($this->nodeId(), strlen($parent->nodeId()));
+        }
+        /**
+         * @return string
+         */
-        public function defaultTitle() {
+        public function defaultTitle(): string {
                 return $this->aid;
+        }
+        /**
+         * @return bool
+         */
-        public function isLeafNode() {
+        public function isLeafNode(): bool {
                 // We don't know when an AID is "leaf", because an AID can have an arbitary length <= 16 Bytes.
                 // But if it is 16 bytes long (32 nibbles), then we are 100% certain that it is a leaf node.
                 return (strlen($this->nodeId(false)) == 32);
+        }
+        /**
+         * @param string $title
+         * @param string $content
+         * @param string $icon
+         * @return void
+         * @throws OIDplusException
+         */
-        public function getContentPage(&$title, &$content, &$icon) {
+        public function getContentPage(string &$title, string &$content, string &$icon) {
                 $icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';
                 if ($this->isRoot()) {
                         $title = OIDplusAid::objectTypeTitle();
+                }
+        }
         # ---
+        /**
+         * @param $withAbbr
+         * @return string
+         * @throws OIDplusException
+         */
         public function chunkedNotation($withAbbr=true) {
                 $curid = self::root().$this->aid;
                 $obj = OIDplusObject::findFitting($curid);
                 if (!$obj) return $this->aid;
                         $full[] = $withAbbr && ($hint !== '') ? '<abbr title="'.htmlentities($hint).'">'.$c.'</abbr>' : $c;
+                }
                 return implode(' ', $full);
+        }
+        /**
+         * @return OIDplusAid|null
+         */
-        public function one_up() {
+        public function one_up()/*: ?OIDplusAid*/ {
-                return OIDplusObject::parse($this->ns().':'.substr($this->aid,0,strlen($this->aid)-1));
+                return self::parse($this->ns().':'.substr($this->aid,0,strlen($this->aid)-1));
+        }
+        /**
+         * @param $to
+         * @return int|null
+         */
         public function distance($to) {
                 if (!is_object($to)) $to = OIDplusObject::parse($to);
-                if (!($to instanceof $this)) return false;
+                if (!($to instanceof $this)) return null;
                 $a = $to->aid;
                 $b = $this->aid;
                 $ary = $a;
                 $bry = $b;
                 $min_len = min(strlen($ary), strlen($bry));
                 for ($i=0; $i<$min_len; $i++) {
-                        if ($ary[$i] != $bry[$i]) return false;
+                        if ($ary[$i] != $bry[$i]) return null;
+                }
                 return strlen($ary) - strlen($bry);
+        }
+        /**
+         * @return array|OIDplusAltId[]
+         * @throws OIDplusException
+         */
-        public function getAltIds() {
+        public function getAltIds(): array {
                 if ($this->isRoot()) return array();
                 $ids = parent::getAltIds();
                 $aid = $this->nodeId(false);
                 $aid = strtoupper($aid);
                 // TODO: If it has no pix, then resolve it !!! but how do we know if there is a PIX or a part ID ?
                 return $ids;
+        }
+        /**
+         * @return string
+         */
-        public function getDirectoryName() {
+        public function getDirectoryName(): string {
                 if ($this->isRoot()) return $this->ns();
                 return $this->ns().'_'.$this->nodeId(false); // safe, because there are only AIDs
+        }
+        /**
+         * @param string $mode
+         * @return string
+         */
-        public static function treeIconFilename($mode) {
+        public static function treeIconFilename(string $mode): string {
                 return 'img/'.$mode.'_icon16.png';
+        }
+}

Subversion Repositories oidplus

oidplus/trunk/plugins/viathinksoft/objectTypes/aid/OIDplusAid.class.php – Rev 1086 → 1116