WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/objectTypes/oid/OIDplusOid.class.php

 // phpcs:enable PSR1.Files.SideEffects
 class OIDplusOid extends OIDplusObject {
         private $oid;
+        /**
+         * @param $oid
+         * @throws OIDplusException
+         */
         public function __construct($oid) {
                 $bak_oid = $oid;
                 $oid = sanitizeOID($oid, 'auto');
                 if ($oid === false) {
+                }
                 $this->oid = $oid;
+        }
+        /**
+         * @param string $node_id
+         * @return OIDplusOid|null
+         */
-        public static function parse($node_id) {
+        public static function parse(string $node_id)/*: ?OIDplusOid*/ {
                 @list($namespace, $oid) = explode(':', $node_id, 2);
-                if ($namespace !== self::ns()) return false;
+                if ($namespace !== self::ns()) return null;
                 return new self($oid);
+        }
+        /**
+         * @return string
+         */
-        public static function objectTypeTitle() {
+        public static function objectTypeTitle(): string {
                 return _L('Object Identifier (OID)');
+        }
+        /**
+         * @return string
+         */
-        public static function objectTypeTitleShort() {
+        public static function objectTypeTitleShort(): string {
                 return _L('OID');
+        }
+        /**
+         * @return string
+         */
-        public static function ns() {
+        public static function ns(): string {
                 return 'oid';
+        }
+        /**
+         * @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->oid == '';
+        }
+        /**
+         * @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->oid : $this->oid;
+        }
+        /**
+         * @param string $str
+         * @return string
+         * @throws OIDplusException
+         */
-        public function addString($str) {
+        public function addString(string $str): string {
                 if (!$this->isRoot()) {
                         if (strpos($str,'.') !== false) throw new OIDplusException(_L('Please only submit one arc (not an absolute OID or multiple arcs).'));
+                }
                 return $this->appendArcs($str)->nodeId();
+        }
+        /**
+         * @param OIDplusObject $parent
+         * @return string
+         */
-        public function crudShowId(OIDplusObject $parent) {
+        public function crudShowId(OIDplusObject $parent): string {
                 if ($parent instanceof OIDplusOid) {
                         return $this->deltaDotNotation($parent);
+                } else {
+                        return '';
+                }
+        }
+        /**
+         * @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();
                 if ($parent instanceof OIDplusOid) {
                         return $this->viewGetArcAsn1s($parent);
                 } else {
                         return '';
+                }
+        }
+        /**
+         * @return string
+         */
-        public function defaultTitle() {
+        public function defaultTitle(): string {
                 return _L('OID %1',$this->oid);
+        }
+        /**
+         * @return bool
+         */
-        public function isLeafNode() {
+        public function isLeafNode(): bool {
                 return false;
+        }
+        /**
+         * @return array
+         */
-        private function getTechInfo() {
+        private function getTechInfo(): array {
                 $tech_info = array();
                 $tmp = _L('Dot notation');
                 $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://oid-rep.orange-labs.fr/faq.htm#14" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);
                 $tech_info[$tmp] = $this->getDotNotation();
                 $tech_info[$tmp] = str_replace(' ', ':', \OidDerConverter::hexarrayToStr(\OidDerConverter::oidToDER($this->nodeId(false))));
                 return $tech_info;
+        }
+        /**
+         * @return bool
+         */
-        protected function isClassCWeid() {
+        protected function isClassCWeid(): bool {
                 $dist = oid_distance($this->oid, '1.3.6.1.4.1.37553.8');
                 if ($dist === false) return false;
                 return $dist >= 0;
+        }
+        /**
+         * @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) {
                 if ($this->isClassCWeid()) {
                         // TODO: Also change treeview menu mini-icon?
                         $icon = file_exists(__DIR__.'/img/weid_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/weid_icon.png' : '';
                 } else {
                         $icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';
+                }
+        }
         # ---
+        /**
-        // Gets the last arc of an WEID
+         * Gets the last arc of an WEID
+         * @return false|string
+         */
         public function weidArc() {
                 // Dirty hack: We prepend '0.' in front of the OID to enforce the
                 //             creation of a Class A weid (weid:root:) . Otherwise we could not
                 //             get the hidden arc value "8" from "weid:4" (which is actually "weid:pen:SZ5-8-?"
                 $weid = \Frdl\Weid\WeidOidConverter::oid2weid('0.'.$this->getDotNotation());
                 $x = explode('-', $weid);
                 if (count($x) < 2) return ''; // WEID root arc. Has no name
                 return $x[count($x)-2];
+        }
+        /**
+         * @param bool $withAbbr
+         * @return string
+         */
-        public function getWeidNotation($withAbbr=true) {
+        public function getWeidNotation(bool $withAbbr=true): string {
                 $weid = \Frdl\Weid\WeidOidConverter::oid2weid($this->getDotNotation());
                 if ($withAbbr) {
                         $ary = explode(':', $weid);
                         $weid = array_pop($ary); // remove namespace and sub-namespace if existing
                         $ns = implode(':', $ary).':';
                         $weid = '<abbr title="'._L('Base OID').': '.$base_arc.'">' . rtrim($ns,':') . '</abbr>:' . implode('-',$weid_arcs);
+                }
                 return $weid;
+        }
+        /**
+         * @param string|int $arcs
+         * @return OIDplusOid
+         * @throws OIDplusException
+         */
-        public function appendArcs(String $arcs) {
+        public function appendArcs($arcs): OIDplusOid {
                 $out = new self($this->oid);
                 if ($out->isRoot()) {
                         $out->oid .= $arcs;
                 } else {
+                }
                 return $out;
+        }
+        /**
+         * @param OIDplusOid $parent
+         * @return false|string
+         */
         public function deltaDotNotation(OIDplusOid $parent) {
                 if (!$parent->isRoot()) {
                         if (substr($this->oid, 0, strlen($parent->oid)+1) == $parent->oid.'.') {
                                 return substr($this->oid, strlen($parent->oid)+1);
                         } else {
                 } else {
                         return $this->oid;
+                }
+        }
+        /**
+         * @return array
+         * @throws OIDplusException
+         */
-        public function getAsn1Ids() {
+        public function getAsn1Ids(): array {
                 $asn_ids = array();
                 $res_asn = OIDplus::db()->query("select * from ###asn1id where oid = ? order by lfd", array("oid:".$this->oid));
                 while ($row_asn = $res_asn->fetch_array()) {
                         $name = $row_asn['name'];
                         $standardized = $row_asn['standardized'];
                         $asn_ids[] = new OIDplusOidAsn1Id($name, $standardized, $well_known);
+                }
                 return $asn_ids;
+        }
+        /**
+         * @return array
+         * @throws OIDplusException
+         */
-        public function getIris() {
+        public function getIris(): array {
                 $iri_ids = array();
                 $res_iri = OIDplus::db()->query("select * from ###iri where oid = ? order by lfd", array("oid:".$this->oid));
                 while ($row_iri = $res_iri->fetch_array()) {
                         $name = $row_iri['name'];
                         $longarc = $row_iri['longarc'];
                         $iri_ids[] = new OIDplusOidIri($name, $longarc, $well_known);
+                }
                 return $iri_ids;
+        }
+        /**
+         * @param OIDplusOid|null $parent
+         * @param $separator
+         * @return string
+         * @throws OIDplusException
+         */
-        public function viewGetArcAsn1s(OIDplusOid $parent=null, $separator = ' | ') {
+        public function viewGetArcAsn1s(OIDplusOid $parent=null, $separator = ' | '): string {
                 $asn_ids = array();
                 if (is_null($parent)) $parent = OIDplusOid::parse(self::root());
                 $part = $this->deltaDotNotation($parent);
                 if (count($asn_ids) == 0) $asn_ids = array($part);
                 return implode($separator, $asn_ids);
+        }
+        /**
+         * @param bool $withAbbr
+         * @return string
+         * @throws OIDplusException
+         */
-        public function getAsn1Notation($withAbbr=true) {
+        public function getAsn1Notation(bool $withAbbr=true): string {
                 $asn1_notation = '';
                 $arcs = explode('.', $this->oid);
                 foreach ($arcs as $arc) {
                         $res = OIDplus::db()->query("select name, standardized from ###asn1id where oid = ? order by lfd", array(self::root().implode('.',$arcs)));
+                }
                 return "{ ".trim($asn1_notation)." }";
+        }
+        /**
+         * @param bool $withAbbr
+         * @return string
+         * @throws OIDplusException
+         */
-        public function getIriNotation($withAbbr=true) {
+        public function getIriNotation(bool $withAbbr=true): string {
                 $iri_notation = '';
                 $arcs = explode('.', $this->oid);
                 foreach ($arcs as $arc) {
                         $res = OIDplus::db()->query("select name, longarc from ###iri where oid = ? order by lfd", array(self::root().implode('.',$arcs)));
                 $iri_notation = '/' . substr($iri_notation, 0, strlen($iri_notation)-1);
                 return $iri_notation;
+        }
+        /**
+         * @return string
+         */
-        public function getDotNotation() {
+        public function getDotNotation(): string {
                 return $this->oid;
+        }
+        /**
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function isWellKnown() {
+        public function isWellKnown(): bool {
                 $res = OIDplus::db()->query("select oid from ###asn1id where oid = ? and well_known = ?", array("oid:".$this->oid,true));
                 if ($res->any()) return true;
                 $res = OIDplus::db()->query("select oid from ###iri where oid = ? and well_known = ?", array("oid:".$this->oid,true));
                 if ($res->any()) return true;
                 return false;
+        }
+        /**
+         * @param array $demandedASN1s
+         * @param bool $simulate
+         * @return void
+         * @throws OIDplusException
+         */
-        public function replaceAsn1Ids($demandedASN1s=array(), $simulate=false) {
+        public function replaceAsn1Ids(array $demandedASN1s=array(), bool $simulate=false) {
                 if ($this->isWellKnown()) {
                         throw new OIDplusException(_L('OID "%1" is a "well-known" OID. Its identifiers cannot be changed.',$this->oid));
+                }
                 // First do a few checks
                                 OIDplus::db()->query("insert into ###asn1id (oid, name) values (?, ?)", array("oid:".$this->oid, $asn1));
+                        }
+                }
+        }
+        /**
+         * @param array $demandedIris
+         * @param bool $simulate
+         * @return void
+         * @throws OIDplusException
+         */
-        public function replaceIris($demandedIris=array(), $simulate=false) {
+        public function replaceIris(array $demandedIris=array(), bool $simulate=false) {
                 if ($this->isWellKnown()) {
                         throw new OIDplusException(_L('OID "%1" is a "well-known" OID. Its identifiers cannot be changed.',$this->oid));
+                }
                 // First do a few checks
                                 OIDplus::db()->query("insert into ###iri (oid, name) values (?, ?)", array("oid:".$this->oid, $iri));
+                        }
+                }
+        }
+        /**
+         * @return OIDplusOid|null
+         */
-        public function one_up() {
+        public function one_up()/*: ?OIDplusOid*/ {
                 return self::parse(self::ns().':'.oid_up($this->oid));
+        }
+        /**
+         * @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;
-                return oid_distance($to->oid, $this->oid);
+                $res = oid_distance($to->oid, $this->oid);
+                return $res !== false ? $res : null;
+        }
+        /**
+         * @return array|OIDplusAltId[]
+         * @throws OIDplusException
+         */
-        public function getAltIds() {
+        public function getAltIds(): array {
                 if ($this->isRoot()) return array();
                 $ids = parent::getAltIds();
                 if ($uuid = oid_to_uuid($this->oid)) {
                         // UUID-OIDs are representation of an UUID
+                }
                 return $ids;
+        }
+        /**
+         * @return string
+         */
-        public function getDirectoryName() {
+        public function getDirectoryName(): string {
                 if ($this->isRoot()) return $this->ns();
                 $oid = $this->nodeId(false);
                 return $this->ns().'_'.str_replace('.', '_', $oid);
+        }
+        /**
+         * @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/oid/OIDplusOid.class.php – Rev 1086 → 1116