WebSVN – oidplus – Diff – /trunk/includes/classes/OIDplusObject.class.php

 // phpcs:enable PSR1.Files.SideEffects
 abstract class OIDplusObject extends OIDplusBaseClass {
         const UUID_NAMEBASED_NS_OidPlusMisc = 'ad1654e6-7e15-11e4-9ef6-78e3b5fc7f22';
+        /**
+         * Please overwrite this function!
+         * @param string $node_id
+         * @return OIDplusObject|null
+         */
-        public static function parse($node_id) { // please overwrite this function!
+        public static function parse(string $node_id)/*: ?OIDplusObject*/ {
                 foreach (OIDplus::getEnabledObjectTypes() as $ot) {
                         try {
                                 $good = false;
                                 if (get_parent_class($ot) == OIDplusObject::class) {
                                         $reflector = new \ReflectionMethod($ot, 'parse');
                         } catch (\Exception $e) {}
+                }
                 return null;
+        }
+        /**
+         * @return OIDplusAltId[]
+         * @throws OIDplusException
+         */
-        public function /*OIDplusAltId[]*/ getAltIds() {
+        public function getAltIds(): array {
                 if ($this->isRoot()) return array();
                 $ids = array();
                 // Creates an OIDplus-Hash-OID
                 // Make a AID based on ViaThinkSoft schema
                 // ... but not for OIDs below oid:1.3.6.1.4.1.37476.30.9, because these are the definition of these Information Object AIDs (which will be decoded in the OID object type plugin)
                 if (($this->ns() != 'aid') && !str_starts_with($this->nodeId(true), 'oid:1.3.6.1.4.1.37476.30.9.')) {
                         $sid = OIDplus::getSystemId(false);
-                        if (!empty($sid)) {
+                        if ($sid !== false) {
                                 $ns_oid = $this->getPlugin()->getManifest()->getOid();
                                 if (str_starts_with($ns_oid, '1.3.6.1.4.1.37476.2.5.2.')) {
                                         // Official ViaThinkSoft object type plugins
                                         // For backwards compatibility with existing IDs,
                                         // set the hash_payload as '<namespace>:<id>'
                                         // Third-party object type plugins
                                         // Set the hash_payload as '<plugin oid>:<id>'
                                         $hash_payload = $ns_oid.':'.$this->nodeId(false);
+                                }
-                                $sid_hex = strtoupper(str_pad(dechex($sid),8,'0',STR_PAD_LEFT));
+                                $sid_hex = strtoupper(str_pad(dechex((int)$sid),8,'0',STR_PAD_LEFT));
                                 $obj_hex = strtoupper(str_pad(dechex(smallhash($hash_payload)),8,'0',STR_PAD_LEFT));
                                 $aid = 'D276000186B20005'.$sid_hex.$obj_hex;
                                 $ids[] = new OIDplusAltId('aid', $aid, _L('OIDplus Information Object Application Identifier (ISO/IEC 7816)'), ' ('._L('No PIX allowed').')');
+                        }
+                }
                 return $ids;
+        }
+        /**
+         * @return string
+         */
-        public abstract static function objectTypeTitle();
+        public abstract static function objectTypeTitle(): string;
+        /**
+         * @return string
+         */
-        public abstract static function objectTypeTitleShort();
+        public abstract static function objectTypeTitleShort(): string;
+        /**
+         * @return OIDplusObjectTypePlugin|null
+         */
         public function getPlugin()/*: ?OIDplusObjectTypePlugin */ {
-                $res = null;
                 $plugins = OIDplus::getObjectTypePlugins();
                 foreach ($plugins as $plugin) {
-                        if (get_class($this) == $plugin::getObjectTypeClassName($this)) {
+                        if (get_class($this) == $plugin::getObjectTypeClassName()) {
                                 return $plugin;
+                        }
+                }
-                return $res;
+                return null;
+        }
+        /**
+         * @return string
+         */
-        public abstract static function ns();
+        public abstract static function ns(): string;
+        /**
+         * @return string
+         */
-        public abstract static function root();
+        public abstract static function root(): string;
+        /**
+         * @return bool
+         */
-        public abstract function isRoot();
+        public abstract function isRoot(): bool;
+        /**
+         * @param bool $with_ns
+         * @return string
+         */
-        public abstract function nodeId($with_ns=true);
+        public abstract function nodeId(bool $with_ns=true): string;
+        /**
+         * @param string $str
+         * @return string mixed
+         * @throws OIDplusException
+         */
-        public abstract function addString($str);
+        public abstract function addString(string $str): string;
+        /**
+         * @param OIDplusObject $parent
+         * @return string
+         */
-        public abstract function crudShowId(OIDplusObject $parent);
+        public abstract function crudShowId(OIDplusObject $parent): string;
+        /**
+         * @return string
+         */
-        public function crudInsertPrefix() {
+        public function crudInsertPrefix(): string {
                 return '';
+        }
+        /**
+         * @return string
+         */
-        public function crudInsertSuffix() {
+        public function crudInsertSuffix(): string {
                 return '';
+        }
+        /**
+         * @param OIDplusObject|null $parent
+         * @return string
+         */
-        public abstract function jsTreeNodeName(OIDplusObject $parent = null);
+        public abstract function jsTreeNodeName(OIDplusObject $parent = null): string;
+        /**
+         * @return string
+         */
-        public abstract function defaultTitle();
+        public abstract function defaultTitle(): string;
+        /**
+         * @return bool
+         */
-        public abstract function isLeafNode();
+        public abstract function isLeafNode(): bool;
+        /**
+         * @param string $title
+         * @param string $content
+         * @param string $icon
+         * @return void
+         */
-        public abstract function getContentPage(&$title, &$content, &$icon);
+        public abstract function getContentPage(string &$title, string &$content, string &$icon);
+        /**
+         * @param OIDplusRA|string|null $ra
+         * @return array
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public static function getRaRoots($ra_email=null) {
+        public static function getRaRoots($ra=null) : array{
-                if ($ra_email instanceof OIDplusRA) $ra_email = $ra_email->raEmail();
+                if ($ra instanceof OIDplusRA) $ra = $ra->raEmail();
                 $out = array();
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
-                        if (!$ra_email) {
+                        if (!$ra) {
                                 $res = OIDplus::db()->query("select oChild.id as id, oChild.ra_email as child_mail, oParent.ra_email as parent_mail from ###objects as oChild ".
                                                             "left join ###objects as oParent on oChild.parent = oParent.id ".
                                                             "order by ".OIDplus::db()->natOrder('oChild.id'));
                                 while ($row = $res->fetch_array()) {
                                         if (!OIDplus::authUtils()->isRaLoggedIn($row['parent_mail']) && OIDplus::authUtils()->isRaLoggedIn($row['child_mail'])) {
                                 $res = OIDplus::db()->query("select oChild.id as id from ###objects as oChild ".
                                                             "left join ###objects as oParent on oChild.parent = oParent.id ".
                                                             "where (".OIDplus::db()->getSlang()->isNullFunction('oParent.ra_email',"''")." <> ? and ".
                                                             OIDplus::db()->getSlang()->isNullFunction('oChild.ra_email',"''")." = ?) or ".
                                                             "      (oParent.ra_email is null and ".OIDplus::db()->getSlang()->isNullFunction('oChild.ra_email',"''")." = ?) ".
-                                                            "order by ".OIDplus::db()->natOrder('oChild.id'), array($ra_email, $ra_email, $ra_email));
+                                                            "order by ".OIDplus::db()->natOrder('oChild.id'), array($ra, $ra, $ra));
                                 while ($row = $res->fetch_array()) {
                                         $x = self::parse($row['id']); // can be FALSE if namespace was disabled
                                         if ($x) $out[] = $x;
+                                }
+                        }
                 } else {
-                        if (!$ra_email) {
+                        if (!$ra) {
                                 $ra_mails_to_check = OIDplus::authUtils()->loggedInRaList();
                                 if (count($ra_mails_to_check) == 0) return $out;
                         } else {
-                                $ra_mails_to_check = array($ra_email);
+                                $ra_mails_to_check = array($ra);
+                        }
                         self::buildObjectInformationCache();
                         foreach ($ra_mails_to_check as $check_ra_mail) {
+                }
                 return $out;
+        }
+        /**
+         * @return array
+         * @throws OIDplusException
+         */
-        public static function getAllNonConfidential() {
+        public static function getAllNonConfidential(): array {
                 $out = array();
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select id from ###objects where confidential = ? order by ".OIDplus::db()->natOrder('id'), array(false));
+                }
                 return $out;
+        }
+        /**
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function isConfidential() {
+        public function isConfidential(): bool {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         //static $confidential_cache = array();
                         $curid = $this->nodeId();
                         //$orig_curid = $curid;
                         //if (isset($confidential_cache[$curid])) return $confidential_cache[$curid];
+                        }
                         return false;
+                }
+        }
+        /**
+         * @param OIDplusObject $obj
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function isChildOf(OIDplusObject $obj) {
+        public function isChildOf(OIDplusObject $obj): bool {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $curid = $this->nodeId();
                         while (($res = OIDplus::db()->query("select parent from ###objects where id = ?", array($curid)))->any()) {
                                 $row = $res->fetch_array();
                                 if ($curid == $obj->nodeId()) return true;
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return array
+         * @throws OIDplusException
+         */
-        public function getChildren() {
+        public function getChildren(): array {
                 $out = array();
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select id from ###objects where parent = ?", array($this->nodeId()));
                         while ($row = $res->fetch_array()) {
                                 $obj = self::parse($row['id']);
+                        }
+                }
                 return $out;
+        }
+        /**
+         * @return OIDplusRA
+         * @throws OIDplusException
+         */
-        public function getRa() {
+        public function getRa(): OIDplusRA {
                 return new OIDplusRA($this->getRaMail());
+        }
+        /**
+         * @param OIDplusRA|string|null $ra
+         * @return bool
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public function userHasReadRights($ra_email=null) {
+        public function userHasReadRights($ra=null): bool {
-                if ($ra_email instanceof OIDplusRA) $ra_email = $ra_email->raEmail();
+                if ($ra instanceof OIDplusRA) $ra = $ra->raEmail();
                 // If it is not confidential, everybody can read/see it.
                 // Note: This also checks if superior OIDs are confidential.
                 if (!$this->isConfidential()) return true;
-                if (!$ra_email) {
+                if (!$ra) {
                         // Admin may do everything
                         if (OIDplus::authUtils()->isAdminLoggedIn()) return true;
                         // If the RA is logged in, then they can see the OID.
                         if (OIDplus::authUtils()->isRaLoggedIn($this->getRaMail())) return true;
                 } else {
                         // If this OID belongs to the requested RA, then they may see it.
-                        if ($this->getRaMail() == $ra_email) return true;
+                        if ($this->getRaMail() == $ra) return true;
+                }
                 // If someone has rights to an object below our confidential node,
                 // we let him see the confidential node,
                 // Otherwise he could not browse through to his own node.
-                $roots = $this->getRaRoots($ra_email);
+                $roots = $this->getRaRoots($ra);
                 foreach ($roots as $root) {
                         if ($root->isChildOf($this)) return true;
+                }
                 return false;
+        }
+        /**
+         * @param array|null $row
+         * @return string|null
+         * @throws OIDplusException
+         */
-        public function getIcon($row=null) {
+        public function getIcon(array $row=null) {
                 $namespace = $this->ns(); // must use $this, not self::, otherwise the virtual method will not be called
                 if (is_null($row)) {
                         $ra_email = $this->getRaMail();
                 } else {
                 if (!file_exists($icon)) return null; // default icon (folder)
                 return $icon;
+        }
+        /**
+         * @param string $id
+         * @return bool
+         * @throws OIDplusException
+         */
-        public static function exists(string $id) {
+        public static function exists(string $id): bool {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select id from ###objects where id = ?", array($id));
                         return $res->any();
                 } else {
                         self::buildObjectInformationCache();
                         return isset(self::$object_info_cache[$id]);
+                }
+        }
+        /**
-        // Get parent gives the next possible parent which is EXISTING in OIDplus
+         * Get parent gives the next possible parent which is EXISTING in OIDplus
-        // It does not give the immediate parent
+         * It does not give the immediate parent
+         * @return OIDplusObject|null
+         * @throws OIDplusException
+         */
         public function getParent()/*: ?OIDplusObject*/ {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select parent from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
                                 if ($fitting = self::findFitting($cur->nodeId())) return $fitting;
                                 $prev = $cur;
                                 $cur = $cur->one_up();
                                 if (!$cur) return null;
-                        } while ($prev != $cur);
+                        } while ($prev !== $cur);
+                }
                 return null;
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getRaMail() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select ra_email from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getTitle() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select title from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getDescription() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select description from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getComment() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select comment from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getCreatedTime() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select created from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return false|string|null
+         * @throws OIDplusException
+         */
         public function getUpdatedTime() {
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
                         $res = OIDplus::db()->query("select updated from ###objects where id = ?", array($this->nodeId()));
                         if (!$res->any()) return null;
                         $row = $res->fetch_array();
+                        }
                         return false;
+                }
+        }
+        /**
+         * @param OIDplusRA|string|null $ra
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function userHasParentalWriteRights($ra_email=null) {
+        public function userHasParentalWriteRights($ra=null) {
-                if ($ra_email instanceof OIDplusRA) $ra_email = $ra_email->raEmail();
+                if ($ra instanceof OIDplusRA) $ra = $ra->raEmail();
-                if (!$ra_email) {
+                if (!$ra) {
                         if (OIDplus::authUtils()->isAdminLoggedIn()) return true;
+                }
                 $objParent = $this->getParent();
                 if (!$objParent) return false;
-                return $objParent->userHasWriteRights($ra_email);
+                return $objParent->userHasWriteRights($ra);
+        }
+        /**
+         * @param OIDplusRA|string|null $ra
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function userHasWriteRights($ra_email=null) {
+        public function userHasWriteRights($ra=null): bool {
-                if ($ra_email instanceof OIDplusRA) $ra_email = $ra_email->raEmail();
+                if ($ra instanceof OIDplusRA) $ra = $ra->raEmail();
-                if (!$ra_email) {
+                if (!$ra) {
                         if (OIDplus::authUtils()->isAdminLoggedIn()) return true;
                         return OIDplus::authUtils()->isRaLoggedIn($this->getRaMail());
                 } else {
-                        return $this->getRaMail() == $ra_email;
+                        return $this->getRaMail() == $ra;
+                }
+        }
+        /**
+         * @param string|OIDplusObject $to
+         * @return int|null
+         */
-        public function distance($to) {
+        public function distance($to)/*: ?int*/ {
                 return null; // not implemented
+        }
+        /**
+         * @param OIDplusObject $obj
+         * @return bool
+         */
-        public function equals($obj) {
+        public function equals(OIDplusObject $obj): bool {
                 if (!is_object($obj)) $obj = OIDplusObject::parse($obj);
                 if (!($obj instanceof $this)) return false;
                 $distance = $this->distance($obj);
                 if (is_numeric($distance)) return $distance === 0; // if the distance function is implemented, use it
                 return $this->nodeId() == $obj->nodeId(); // otherwise compare the node id case-sensitive
+        }
+        /**
+         * @param string $id
+         * @return OIDplusObject|false
+         * @throws OIDplusException
+         */
         public static function findFitting(string $id) {
                 $obj = OIDplusObject::parse($id);
                 if (!$obj) return false; // e.g. if ObjectType plugin is disabled
                 if (!OIDplus::baseConfig()->getValue('OBJECT_CACHING', true)) {
+                        }
                         return false;
+                }
+        }
+        /**
+         * @return OIDplusObject|null
+         */
-        public function one_up() {
+        public function one_up()/*: ?OIDplusObject*/ {
                 return null; // not implemented
+        }
         // Caching stuff
         protected static $object_info_cache = null;
+        /**
+         * @return void
+         */
         public static function resetObjectInformationCache() {
                 self::$object_info_cache = null;
+        }
         const CACHE_ID = 'id';
         const CACHE_CONFIDENTIAL = 'confidential';
         const CACHE_CREATED = 'created';
         const CACHE_UPDATED = 'updated';
         const CACHE_COMMENT = 'comment';
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         private static function buildObjectInformationCache() {
                 if (is_null(self::$object_info_cache)) {
                         self::$object_info_cache = array();
                         $res = OIDplus::db()->query("select * from ###objects");
                         while ($row = $res->fetch_array()) {
                                 self::$object_info_cache[$row['id']] = $row;
+                        }
+                }
+        }
+        /**
-        // override this function if you want your object type to save
+         * override this function if you want your object type to save
-        // attachments in directories with easy names.
+         * attachments in directories with easy names.
-        // Take care that your custom directory name will not allow jailbreaks (../) !
+         * Take care that your custom directory name will not allow jailbreaks (../) !
+         * @return string
+         * @throws OIDplusException
+         */
-        public function getDirectoryName() {
+        public function getDirectoryName(): string {
                 if ($this->isRoot()) return $this->ns();
                 return $this->getLegacyDirectoryName();
+        }
+        /**
+         * @return string
+         * @throws OIDplusException
+         */
-        public final function getLegacyDirectoryName() {
+        public final function getLegacyDirectoryName(): string {
                 if ($this::ns() == 'oid') {
                         $oid = $this->nodeId(false);
                 } else {
                         $oid = null;
                         $alt_ids = $this->getAltIds();
                         // Can happen if you don't have a system ID (due to missing OpenSSL plugin)
                         return md5($this->nodeId(true)); // we don't use $id, because $this->nodeId(true) is possibly more canonical than $id
+                }
+        }
+        /**
+         * @param string $mode
+         * @return string
+         */
-        public static function treeIconFilename($mode) {
+        public static function treeIconFilename(string $mode): string {
                 // for backwards-compatibility with older plugins
                 return 'img/treeicon_'.$mode.'.png';
+        }
+}

Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplusObject.class.php – Rev 1086 → 1116