Concept::getXlLabel() - Code Metrics - Inspection of "Concept page: special display for deprecated conce..." - NatLibFi/Skosmos - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#1918)

by Osma
created 2026-01-29 15:05 UTC
Concept::getXlLabel() A

↳ Parent: Concept
Complexity

Conditions	4
Paths	3
Size

Total Lines	10
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	6
nc	3
nop	0
dl	0
loc	10
rs	10
c	0
b	0
f	0
<?php

/**
 * Dataobject for a single concept.
 */

class Concept extends VocabularyDataObject implements Modifiable
{
    /**
     * Stores a label string if the concept has been found through
     * a altLabel/label in a another language than the ui.
     */
    private $foundby;
    /** Type of foundby match: 'alt', 'hidden' or 'lang' */
    private $foundbytype;
    /** the EasyRdf\Graph object of the concept */
    private $graph;
    private $clang;
    private $deleted;

    /** concept properties that should not be shown to users */
    private $DELETED_PROPERTIES = array(
        'skosext:broaderGeneric', # these are remnants of bad modeling
        'skosext:broaderPartitive', #

        'skos:hiddenLabel', # because it's supposed to be hidden
        'skos:prefLabel', # handled separately by getLabel
        'rdfs:label', # handled separately by getLabel

        'skos:topConceptOf', # because it's too technical, not relevant for users
        'skos:inScheme', # should be evident in any case
        'skos:member', # this shouldn't be shown on the group page
        'dc:created', # handled separately
        'dc:modified', # handled separately
        'owl:deprecated', # indicated visually
    );

    /** related concepts that should be shown to users in the appendix */
    private $MAPPING_PROPERTIES = array(
        'skos:exactMatch',
        'skos:narrowMatch',
        'skos:broadMatch',
        'skos:closeMatch',
        'skos:relatedMatch',
        'rdfs:seeAlso',
        'owl:sameAs',
    );

    /** default external properties we are interested in saving/displaying from mapped external objects */
    private $DEFAULT_EXT_PROPERTIES = array(
        "dc11:title",
        "dcterms:title",
        "skos:prefLabel",
        "skos:exactMatch",
        "skos:closeMatch",
        "skos:inScheme",
        "rdfs:label",
        "rdfs:isDefinedBy",
        "owl:sameAs",
        "rdf:type",
        "void:inDataset",
        "void:sparqlEndpoint",
        "void:uriLookupEndpoint",
        "schema:about",
        "schema:description",
        "schema:inLanguage",
        "schema:name",
        "schema:isPartOf",
        "wdt:P31",
        "wdt:P625"
    );

    /**
     * Initializing the concept object requires the following parameters.
     * @param Model $model
     * @param Vocabulary $vocab
     * @param EasyRdf\Resource $resource
     * @param EasyRdf\Graph $graph
     */
    public function __construct($model, $vocab, $resource, $graph, $clang)
    {
        parent::__construct($model, $vocab, $resource);
        $this->deleted = $this->DELETED_PROPERTIES;
        if ($vocab !== null) {
            $this->order = $vocab->getConfig()->getPropertyOrder();
            // delete notations unless configured to show them
            if (!$vocab->getConfig()->getShowNotationAsProperty()) {
                $this->deleted[] = 'skos:notation';
            }
        } else {
            $this->order = VocabularyConfig::DEFAULT_PROPERTY_ORDER;
        }
        $this->graph = $graph;
        $this->clang = $clang;
    }

    /**
     * Returns the concept uri.
     * @return string
     */
    public function getUri()
    {
        return $this->resource->getUri();
    }

    public function getType()
    {
        return $this->resource->types();
    }


    /**
     * Returns a boolean value indicating whether the resource is a group defined in the vocab config as skosmos:groupClass.
     * @return boolean
     */
    public function isGroup()
    {
        $groupClass = $this->getVocab()->getConfig()->getGroupClassURI();
        if ($groupClass) {
            $groupClass = $this->shortenOrKeep($groupClass);
            return in_array($groupClass, $this->getType());
        }
        return false;
    }

    /**
     * Returns a boolean value indicating if the concept has been deprecated.
     * @return boolean
     */
    public function getDeprecated()
    {
        $deprecatedValue = $this->resource->getLiteral('owl:deprecated');
        return ($deprecatedValue !== null && filter_var($deprecatedValue->getValue(), FILTER_VALIDATE_BOOLEAN));
    }

    /**
     * Returns an array of dct:isReplacedBy values
     * @return ConceptPropertyValue[]
     */
    public function getIsReplacedBy()
    {
        $values = [];
        foreach ($this->resource->allResources('dc:isReplacedBy') as $res) {
            $values[] = new ConceptPropertyValue($this->model, $this->vocab, $res, 'dc:isReplacedBy', $this->clang);
        }
        return $values;
    }

    /**
     * Returns a label for the concept in the content language or if not possible in any language.
     * @return string
     */
    public function getLabel()
    {
        foreach ($this->vocab->getConfig()->getLanguageOrder($this->clang) as $fallback) {
            if ($this->resource->label($fallback) !== null) {
                return $this->resource->label($fallback);
            }
            // We need to check all the labels in case one of them matches a subtag of the current language
            foreach ($this->resource->allLiterals('skos:prefLabel') as $label) {
                // the label lang code is a subtag of the UI lang eg. en-GB - create a new literal with the main language
                if ($label !== null && strpos($label->getLang(), $fallback . '-') === 0) {
                    return EasyRdf\Literal::create($label, $fallback);
                }
            }
        }

        // Last resort: label in any language, including literal with empty language tag
        $label = $this->resource->label();
        if ($label !== null) {
            if (!$label->getLang()) {
                return $label->getValue();

            }
            return EasyRdf\Literal::create($label->getValue(), $label->getLang());
        }

        // empty
        return "";
    }

    public function hasXlLabel()
    {
        $xlLabel = $this->getXlLabel();
        return ($xlLabel !== null && !empty($xlLabel->getProperties()));
    }

    public function getXlLabel()
    {
        $labels = $this->resource->allResources('skosxl:prefLabel');
        foreach ($labels as $labres) {
            $label = $labres->getLiteral('skosxl:literalForm');
            if ($label !== null && $label->getLang() == $this->clang) {
                return new LabelSkosXL($this->model, $labres);
            }
        }
        return null;
    }

    /**
     * Returns a notation for the concept or null if it has not been defined.
     * @return string eg. '999'
     */
    public function getNotation()
    {
        $notation = $this->resource->get('skos:notation');
        if ($this->vocab->getConfig()->showNotation() && $notation !== null) {
            return $notation->getValue();
        }

        return null;
    }

    /**
     * Returns the Vocabulary object or undefined if that is not available.
     * @return Vocabulary
     */
    public function getVocab()
    {
        return $this->vocab;
    }

    /**
     * Returns the vocabulary shortname string or id if that is not available.
     * @return string
     */
    public function getShortName()
    {
        return $this->vocab ? $this->vocab->getShortName() : null;
    }

    /**
     * Returns the vocabulary shortname string or id if that is not available.
     * @return string
     */
    public function getVocabTitle()
    {
        return $this->vocab ? $this->vocab->getTitle() : null;
    }

    /**
     * Setter for the $clang property.
     * @param string $clang language code eg. 'en'
     */
    public function setContentLang($clang)
    {
        $this->clang = $clang;
    }

    public function getContentLang()
    {
        return $this->clang;
    }

    /**
     * Setter for the $foundby property.
     * @param string $label label that was matched
     * @param string $type type of match: 'alt', 'hidden', or 'lang'
     */
    public function setFoundBy($label, $type)
    {
        $this->foundby = $label;
        $this->foundbytype = $type;
    }

    /**
     * Getter for the $foundby property.
     * @return string
     */
    public function getFoundBy()
    {
        return $this->foundby;
    }

    /**
     * Getter for the $foundbytype property.
     * @return string
     */
    public function getFoundByType()
    {
        return $this->foundbytype;
    }

    /**
     * Processes a single external resource i.e., adds the properties from
     * 1) $this->$DEFAULT_EXT_PROPERTIES
     * 2) VocabConfig external properties
     * 3) Possible plugin defined external properties
     * to $this->graph
     * @param EasyRdf\Resource $res
     */
    public function processExternalResource($res)
    {
        $exGraph = $res->getGraph();
        // catch external subjects that have $res as object
        $extSubjects = $exGraph->resourcesMatching("schema:about", $res);

        $propList =  array_unique(array_merge(
            $this->DEFAULT_EXT_PROPERTIES,
            $this->getVocab()->getConfig()->getExtProperties(),
            $this->getVocab()->getConfig()->getPluginRegister()->getExtProperties()
        ));

        $seen = array();
        $this->addExternalTriplesToGraph($res, $seen, $propList);
        foreach ($extSubjects as $extSubject) {
            if ($extSubject->isBNode() && array_key_exists($extSubject->getUri(), $seen)) {
                // already processed, skip
                continue;
            }
            $seen[$extSubject->getUri()] = 1;
            $this->addExternalTriplesToGraph($extSubject, $seen, $propList);
        }

    }

    /**
     * Adds resource properties to $this->graph
     * @param EasyRdf\Resource $res
     * @param string[] $seen Processed resources so far
     * @param string[] $props (optional) limit to these property URIs
     */
    private function addExternalTriplesToGraph($res, &$seen, $props = null)
    {
        if (array_key_exists($res->getUri(), $seen) && $seen[$res->getUri()] === 0) {

            return;
        }
        $seen[$res->getUri()] = 0;

        if ($res->isBNode() || is_null($props)) {
            foreach ($res->propertyUris() as $prop) {
                $this->addPropertyValues($res, $prop, $seen);
            }
        } else {
            foreach ($props as $prop) {
                if ($res->hasProperty($prop)) {
                    $this->addPropertyValues($res, $prop, $seen);
                }
            }
        }
    }

    /**
     * Adds values of a single single property of a resource to $this->graph
     * implements Concise Bounded Description definition
     * @param EasyRdf\Resource $res
     * @param string $prop
     * @param string[] $seen Processed resources so far
     */
    private function addPropertyValues($res, $prop, &$seen)
    {
        $resList = $res->allResources('<' . $prop . '>');

        foreach ($resList as $res2) {
            if ($res2->isBNode()) {
                $this->addExternalTriplesToGraph($res2, $seen);
            }
            $this->graph->addResource($res, $prop, $res2);
            $this->addResourceReifications($res, $prop, $res2, $seen);
        }

        $litList = $res->allLiterals('<' . $prop . '>');

        foreach ($litList as $lit) {
            $this->graph->addLiteral($res, $prop, $lit);
            $this->addLiteralReifications($res, $prop, $lit, $seen);
        }
    }

    /**
     * Adds reifications of a triple having a literal object to $this->graph
     * @param EasyRdf\Resource $sub
     * @param string $pred
     * @param EasyRdf\Literal $obj
     * @param string[] $seen Processed resources so far
     */
    private function addLiteralReifications($sub, $pred, $obj, &$seen)
    {
        $pos_reifs = $sub->getGraph()->resourcesMatching("rdf:subject", $sub);
        foreach ($pos_reifs as $pos_reif) {
            $lit = $pos_reif->getLiteral("rdf:object", $obj->getLang());

            if (!is_null($lit) && $lit->getValue() === $obj->getValue() &&
                $pos_reif->isA("rdf:Statement") &&
                $pos_reif->hasProperty("rdf:predicate", new EasyRdf\Resource($pred, $sub->getGraph()))) {
                $this->addExternalTriplesToGraph($pos_reif, $seen);
            }
        }
    }

    /**
     * Adds reifications of a triple having a resource object to $this->graph
     * @param EasyRdf\Resource $sub
     * @param string $pred
     * @param EasyRdf\Resource $obj
     * @param string[] $seen Processed resources so far
     */
    private function addResourceReifications($sub, $pred, $obj, &$seen)
    {
        $pos_reifs = $sub->getGraph()->resourcesMatching("rdf:subject", $sub);
        foreach ($pos_reifs as $pos_reif) {
            if ($pos_reif->isA("rdf:Statement") &&
                $pos_reif->hasProperty("rdf:object", $obj) &&
                $pos_reif->hasProperty("rdf:predicate", new EasyRdf\Resource($pred, $sub->getGraph()))) {
                $this->addExternalTriplesToGraph($pos_reif, $seen);
            }
        }
    }

    /**
     * @param string[]|null $allowedProperties List of properties to include, or null to include all.
     * @return ConceptProperty[]
     */
    public function getMappingProperties(array $allowedProperties = null)
    {
        $ret = array();

        foreach ($this->resource->propertyUris() as &$longUri) {
foreach ($array as &$itemValue) { }
            $prop = $this->shortenOrKeep($longUri);
            // EasyRdf requires full URIs to be in angle brackets
            $sprop = ($prop == $longUri) ? "<$longUri>" : $prop;
            if ($allowedProperties && !in_array($prop, $allowedProperties)) {
                // allowedProperties in use and this is not an allowed property, skipping
                continue;
            }

            if (in_array($prop, $this->MAPPING_PROPERTIES) && !in_array($prop, $this->DELETED_PROPERTIES)) {
                $propres = new EasyRdf\Resource($prop, $this->graph);
                $proplabel = $propres->label($this->getLang()) ? $propres->label($this->getLang()) : $propres->label(); // current language
                $propobj = new ConceptProperty($this->model, $prop, $proplabel);
                $propobj = new ConceptProperty(/** @scrutinizer ignore-type */ $this->model, $prop, $proplabel);
                if ($propobj->getLabel() !== null) {
                    // only display properties for which we have a label
                    $ret[$prop] = $propobj;
                }

                // Iterating through every resource and adding these to the data object.
                foreach ($this->resource->allResources($sprop) as $resourceValue) {
                    if (isset($ret[$prop])) {
                        // checking if the target vocabulary can be found at the skosmos endpoint
                        $exuri = $resourceValue->getUri();
                        // if multiple vocabularies are found, the following method will return in priority the current vocabulary of the concept
                        $exvoc = $this->model->guessVocabularyFromURI($exuri, $this->vocab->getId());
                        // if not querying the uri itself
                        if (!$exvoc) {
                            $response = null;
                            // if told to do so in the vocabulary configuration
                            if ($this->vocab->getConfig()->getExternalResourcesLoading()) {
                                $response = $this->model->getResourceFromUri($exuri);
                            }

                            if ($response) {
                                $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $response, $this->resource, $prop));

                                $this->processExternalResource($response);

                                continue;
                            }
                        }
                        $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $resourceValue, $this->resource, $prop, $this->clang));
                    }
                }
            }
        }

        // sorting the properties to a order preferred in the Skosmos concept page.
        return $this->arbitrarySort($ret);
    }

    private function shortenOrKeep($uri)
    {
        return EasyRdf\RdfNamespace::shorten($uri) ?? $uri;
    }

    private function getCollectionMembersInUse(): array
    {
        $inCollection = [];
        $membersArray = [];

        $arrayClassUri = $this->vocab->getConfig()->getArrayClassURI();
        if ($arrayClassUri === null) {

            return ['inCollection' => $inCollection, 'membersArray' => $membersArray];
        }

        $collections = $this->graph->allOfType($arrayClassUri);
        if (count($collections) === 0) {
            return ['inCollection' => $inCollection, 'membersArray' => $membersArray];
        }

        // Index narrowers by URI
        $narrowersByUri = [];
        foreach ($this->resource->allResources('skos:narrower') as $narrower) {
            $narrowersByUri[$narrower->getUri()] = $narrower;
        }

        foreach ($collections as $coll) {
            $currCollMembers = $this->getCollectionMembers($coll, $narrowersByUri);

            foreach ($currCollMembers as $collection) {
                if ($collection->getSubMembers()) {
                    foreach ($collection->getSubMembers() as $member) {
                        $inCollection[$member->getUri()] = true;
                    }
                }
            }

            if (isset($collection) && $collection->getSubMembers()) {
                $membersArray = array_merge($membersArray, $currCollMembers);
            }
        }

        return ['inCollection' => $inCollection, 'membersArray' => $membersArray];
    }


    /**
     * Iterates over all the properties of the concept and returns those in an array.
     * @param string[]|null $allowedProperties List of properties to include, or null to include all.
     * @return array
     */
    public function getProperties($allowedProperties = null)
    {
        $properties = array();
        $duplicates = array();
        $propertiesWithValues = array();

        $collectionData = $this->getCollectionMembersInUse();
        $inCollection = $collectionData['inCollection'];
        $membersArray = $collectionData['membersArray'];

        if (!empty($membersArray)) {
            $properties['skos:narrower'] = $membersArray;
        }

        foreach ($this->resource->propertyUris() as &$longUri) {
foreach ($array as &$itemValue) { }
            // storing full URI without brackets in a separate variable
            $prop = $this->shortenOrKeep($longUri);
            // EasyRdf requires full URIs to be in angle brackets
            $sprop = ($prop == $longUri) ? "<$longUri>" : $prop;

            if ($allowedProperties !== null && !in_array($prop, $allowedProperties)) {
                continue;
            }

            if (!in_array($prop, $this->deleted) || ($this->isGroup() === false && $prop === 'skos:member')) {
            if (!in_array($prop, /** @scrutinizer ignore-type */ $this->deleted) || ($this->isGroup() === false && $prop === 'skos:member')) {
                // retrieve property label and super properties from the current vocabulary first
                $propertyResource = new EasyRdf\Resource($prop, $this->graph);
                $proplabel = $propertyResource->label($this->getLang()) ? $propertyResource->label($this->getLang()) : $propertyResource->label();

                $prophelp = $propertyResource->getLiteral('rdfs:comment|skos:definition', $this->getLang());
                if ($prophelp === null) {
                    // try again without language restriction
                    $prophelp = $propertyResource->getLiteral('rdfs:comment|skos:definition');
                }

                // check if the property is one of the well-known properties for which we have a translation
                // if it is then we can skip the additional lookups in the default graph
                $propkey = (substr($prop, 0, 5) == 'dc11:') ?
                    str_replace('dc11:', 'dc:', $prop) : $prop;
                $is_well_known = ($this->model->getText($propkey) != $propkey);

                // if not found in current vocabulary, look up in the default graph to be able
                // to read an ontology loaded in a separate graph
                // note that this imply that the property has an rdf:type declared for the query to work
                if (!$is_well_known && !$proplabel) {
                    $envLangLabels = $this->model->getDefaultSparql()->queryLabel($longUri, $this->getLang());

                    $defaultPropLabel = $this->model->getDefaultSparql()->queryLabel($longUri, '');

                    if ($envLangLabels) {
                        $proplabel = $envLangLabels[$this->getLang()];
                    } else {
                        if ($defaultPropLabel) {
                            $proplabel = $defaultPropLabel[''];
                        }
                    }
                }

                // look for superproperties in the current graph
                $superprops = array();
                foreach ($this->graph->allResources($prop, 'rdfs:subPropertyOf') as $superProperty) {
                    $superprops[] = $superProperty->getUri();
                }

                // also look up superprops in the default graph if not found in current vocabulary
                if (!$is_well_known && (!$superprops || empty($superprops))) {
                    $superprops = $this->model->getDefaultSparql()->querySuperProperties($longUri);
                }

                // we're reading only one super property, even if there are multiple ones
                $superprop = ($superprops) ? $this->shortenOrKeep($superprops[0]) : null;
                $sort_by_notation = $this->vocab->getConfig()->getSortByNotation();
                $propobj = new ConceptProperty($this->model, $prop, $proplabel, $prophelp, $superprop, $sort_by_notation);
                $propobj = new ConceptProperty(/** @scrutinizer ignore-type */ $this->model, $prop, $proplabel, $prophelp, $superprop, $sort_by_notation);

                if ($propobj->getLabel() !== null) {
                    // only display properties for which we have a label
                    $propertiesWithValues[$prop] = $propobj;
                }

                // searching for subproperties of literals too
                if ($superprops) {
                    foreach ($superprops as $superProperty) {
                        $duplicates[$this->shortenOrKeep($superProperty)] = $prop;
                    }
                }

                // Iterating through every literal and adding these to the data object.
                foreach ($this->resource->allLiterals($sprop) as $literalValue) {
                    $literal = new ConceptPropertyValueLiteral($this->model, $this->vocab, $this->resource, $literalValue, $prop);
                    // only add literals when they match the content/hit language or have no language defined OR when they are literals of a multilingual property
                    if (isset($propertiesWithValues[$prop]) && ($literal->getLang() === $this->clang || $literal->getLang() === null) || $this->vocab->getConfig()->hasMultiLingualProperty($prop)) {

                        $propertiesWithValues[$prop]->addValue($literal);
                    }
                }

                // Iterating through every resource and adding these to the data object.
                foreach ($this->resource->allResources($sprop) as $resourceValue) {
                    // skipping narrower concepts which are already shown in a collection
                    if ($sprop === 'skos:narrower' && array_key_exists($resourceValue->getUri(), $inCollection)) {
                        continue;
                    }

                    // hiding rdf:type property if it's just skos:Concept
                    if ($sprop === 'rdf:type' && $resourceValue->shorten() === 'skos:Concept') {
                        continue;
                    }

                    // handled by getMappingProperties()
                    if (in_array($sprop, $this->MAPPING_PROPERTIES)) {
                        continue;
                    }

                    if (isset($propertiesWithValues[$prop])) {
                        // create a ConceptPropertyValue first, assuming the resource exists in current vocabulary
                        $value = new ConceptPropertyValue($this->model, $this->vocab, $resourceValue, $prop, $this->clang);
                        $propertiesWithValues[$prop]->addValue($value);
                    }

                }
            }
        }
        // adding narrowers part of a collection
        foreach ($properties as $prop => $values) {
            foreach ($values as $value) {
                $propertiesWithValues[$prop]->addValue($value);
            }
        }

        $groupPropObj = new ConceptProperty($this->model, 'skosmos:memberOf', null);
        foreach ($this->getGroupProperties() as $propVals) {
            foreach ($propVals as $propVal) {
                $groupPropObj->addValue($propVal);
            }
        }
        $propertiesWithValues['skosmos:memberOf'] = $groupPropObj;

        $arrayPropObj = new ConceptProperty($this->model, 'skosmos:memberOfArray', null);
        foreach ($this->getArrayProperties() as $propVals) {
            foreach ($propVals as $propVal) {
                $arrayPropObj->addValue($propVal);
            }
        }
        $propertiesWithValues['skosmos:memberOfArray'] = $arrayPropObj;

        foreach ($propertiesWithValues as $key => $prop) {
            if (sizeof($prop->getValues()) === 0) {
                unset($propertiesWithValues[$key]);
            }
        }

        $propertiesWithValues = $this->removeDuplicatePropertyValues($propertiesWithValues, $duplicates);
        // sorting the properties to the order preferred in the Skosmos concept page.
        return $this->arbitrarySort($propertiesWithValues);
    }

    /**
     * Removes properties that have duplicate values.
     * @param array $propertiesWithValues the array of properties generated by getProperties
     * @param array $duplicates array of properties found are a subProperty of a another property
     * @return array of ConceptProperties
     */
    public function removeDuplicatePropertyValues($propertiesWithValues, $duplicates)
    {
        $propertyValues = array();

        foreach ($propertiesWithValues as $prop) {
            foreach ($prop->getValues() as $value) {
                $label = $value->getLabel(allowExternal: false);
                $propertyValues[(is_object($label) && method_exists($label, 'getValue')) ? $label->getValue() : $label][] = $value->getType();
            }
        }

        foreach ($propertyValues as $value => $propnames) {
            // if there are multiple properties with the same string value.
            if (count($propnames) > 1) {
                foreach ($propnames as $property) {
                    // if there is a more accurate property delete the more generic one.
                    if (isset($duplicates[$property])) {
                        unset($propertiesWithValues[$property]);
                    }
                }

            }
        }
        // handled separately: remove duplicate skos:prefLabel value (#854)
        if (isset($duplicates["skos:prefLabel"])) {
            unset($propertiesWithValues[$duplicates["skos:prefLabel"]]);
        }
        return $propertiesWithValues;
    }

    /**
     * @param $lang UI language
filter:
    dependency_paths: ["lib/*"]
     * @return String|null the translated label of skos:prefLabel subproperty, or null if not available
     */
    public function getPreferredSubpropertyLabelTranslation($lang)
    {
        $prefLabelProp = $this->graph->resource("skos:prefLabel");
        $subPrefLabelProps = $this->graph->resourcesMatching('rdfs:subPropertyOf', $prefLabelProp);
        foreach ($subPrefLabelProps as $subPrefLabelProp) {
            // return the first available translation
            if ($subPrefLabelProp->label($lang)) {
                return $subPrefLabelProp->label($lang);
            }
        }
        return null;
    }

    /**
     * @return DateTime|null the modified date, or null if not available
     */
    public function getModifiedDate()
    {
        // finding the modified properties
        /** @var \EasyRdf\Resource|\EasyRdf\Literal|null $modifiedResource */
        $modifiedResource = $this->resource->get('dc:modified');
        if ($modifiedResource && $modifiedResource instanceof \EasyRdf\Literal\Date) {
            return $modifiedResource->getValue();
        }

        // if the concept does not have a modified date, we look for it in its
        // vocabulary
        return $this->getVocab()->getModifiedDate();
    }

    /**
     * Gets the creation date and modification date if available.
     * @return String containing the date information in a human readable format.
     */
    public function getDate()
    {
        $ret = '';
        $created = '';
        try {
            // finding the created properties
            if ($this->resource->get('dc:created')) {
                $created = $this->resource->get('dc:created')->getValue();
            }

            $modified = $this->getModifiedDate();

            // making a human readable string from the timestamps
            if ($created != '') {
                $ret = $this->model->getText('skosmos:created') . ' ' . (Punic\Calendar::formatDate($created, 'short', $this->getLang()));
            }

            if ($modified != '') {
                if ($created != '') {
                    $ret .= ', ' . $this->model->getText('skosmos:modified') . ' ' . (Punic\Calendar::formatDate($modified, 'short', $this->getLang()));
                } else {
                    $ret .= ' ' . ucfirst($this->model->getText('skosmos:modified')) . ' ' . (Punic\Calendar::formatDate($modified, 'short', $this->getLang()));
                }

            }
        } catch (Exception $e) {
            trigger_error($e->getMessage(), E_USER_WARNING);
            $ret = '';
            if ($this->resource->get('dc:modified')) {
                $modified = (string) $this->resource->get('dc:modified');
                $ret = $this->model->getText('skosmos:modified') . ' ' . $modified;
            }
            if ($this->resource->get('dc:created')) {
                $created .= (string) $this->resource->get('dc:created');
                $ret .= ' ' . $this->model->getText('skosmos:created') . ' ' . $created;
            }
        }
        return $ret;
    }

    /**
     * Gets the members of a specific collection.
     * @param $coll
     * @param array containing all narrowers as EasyRdf\Resource
filter:
    dependency_paths: ["lib/*"]
     * @return array containing ConceptPropertyValue objects
     */
    private function getCollectionMembers($coll, $narrowers)
    {
        $membersArray = array();
        if ($coll->label()) {
            $collLabel = $coll->label()->getValue($this->clang) ? $coll->label($this->clang) : $coll->label();
            if ($collLabel) {
                $collLabel = $collLabel->getValue();
            }
        } else {
            $collLabel = $coll->getUri();
        }
        $membersArray[$collLabel] = new ConceptPropertyValue($this->model, $this->vocab, $coll, 'skos:narrower', $this->clang);
        foreach ($coll->allResources('skos:member') as $member) {
            if (array_key_exists($member->getUri(), $narrowers)) {
                $narrower = $narrowers[$member->getUri()];
                if (isset($narrower)) {
                    $membersArray[$collLabel]->addSubMember(new ConceptPropertyValue($this->model, $this->vocab, $narrower, 'skos:member', $this->clang), $this->clang);
                }

            }
        }

        return $membersArray;
    }

    /**
     * Gets the groups the concept belongs to.
     */
    public function getGroupProperties()
    {
        return $this->getCollections(false);
    }

    /**
     * Gets the groups/arrays the concept belongs to.
     */
    private function getCollections($includeArrays)
    {
        $groups = array();
        $collections = $this->graph->resourcesMatching('skos:member', $this->resource);
        if (isset($collections)) {
            $arrayClassURI = $this->vocab !== null ? $this->vocab->getConfig()->getArrayClassURI() : null;
            $arrayClass = $arrayClassURI !== null ? EasyRdf\RdfNamespace::shorten($arrayClassURI) : null;
            $superGroups = $this->resource->all('isothes:superGroup');
            $superGroupUris = array_map(function ($obj) { return $obj->getUri(); }, $superGroups);
            foreach ($collections as $collection) {
                if (in_array($arrayClass, $collection->types()) === $includeArrays) {
                    // not adding the memberOf if the reverse resource is already covered by isothes:superGroup see issue #433
                    if (in_array($collection->getUri(), $superGroupUris)) {
                        continue;
                    }
                    $property = in_array($arrayClass, $collection->types()) ? "skosmos:memberOfArray" : "skosmos:memberOf";
                    $collLabel = $collection->label($this->clang) ? $collection->label($this->clang) : $collection->label();
                    if ($collLabel) {
                        $collLabel = $collLabel->getValue();
                    }

                    $group = new ConceptPropertyValue($this->model, $this->vocab, $collection, $property, $this->clang);
                    $groups[$collLabel] = array($group);

                    $res = $collection;
                    while ($super = $this->graph->resourcesMatching('skos:member', $res)) {
                        foreach ($super as $res) {
                            $superprop = new ConceptPropertyValue($this->model, $this->vocab, $res, 'skosmos:memberOfSuper', $this->clang);
                            array_unshift($groups[$collLabel], $superprop);
                        }
                    }
                }
            }
        }
        uksort($groups, 'strcoll');
        return $groups;
    }

    public function getArrayProperties()
    {
        return $this->getCollections(true);
    }

    /**
     * Given a language code, gets its name in UI language via Punic or alternatively
     * tries to search for getText translation from Model.
     * @param string $langCode
     * @return string e.g. 'English'
     */
    private function langToString($langCode)
    {
        // using empty string as the language name when there is no langcode set
        $langName = '';
        if (!empty($langCode)) {
            $langName = Punic\Language::getName($langCode, $this->getLang()) !== $langCode ? Punic\Language::getName($langCode, $this->getLang()) : $this->model->getText($langCode);
        }
        return $langName;
    }

    /**
     * Gets the values of a property in all other languages than in the current language
     * and places them in a [langCode][userDefinedKey] array.
     * @param string $prop The property for which the values are looked upon to
     * @param string $key User-defined key for accessing the values
     * @return array LangCode-based multidimensional array ([string][string][ConceptPropertyValueLiteral]) or empty array if no values
     */
    private function getForeignLabelList($prop, $key)
    {
        $ret = array();
        $labels = $this->resource->allLiterals($prop);

        foreach ($labels as $lit) {
            // filtering away subsets of the current language eg. en vs en-GB
            $langCode = strval($lit->getLang());
            if ($langCode != $this->clang && strpos($langCode, $this->getLang() . '-') !== 0) {
                $ret[$langCode][$key][] = new ConceptPropertyValueLiteral($this->model, $this->vocab, $this->resource, $lit, $prop);
            }
        }
        return $ret;
    }

    /**
     * Gets the values of skos:prefLabel and skos:altLabel in all other languages than in the current language.
     * @return array Language-based multidimensional sorted array ([string][string][ConceptPropertyValueLiteral]) or empty array if no values
     */
    public function getForeignLabels()
    {
        $prefLabels = $this->getForeignLabelList('skos:prefLabel', 'prefLabel');
        $altLabels = $this->getForeignLabelList('skos:altLabel', 'altLabel');
        $ret = array_merge_recursive($prefLabels, $altLabels);

        $langArray = array_keys($ret);
        foreach ($langArray as $lang) {
            $coll = collator_create($lang);
            if (isset($ret[$lang]['prefLabel'])) {
                $coll->sort($ret[$lang]['prefLabel'], Collator::SORT_STRING);
            }
            if (isset($ret[$lang]['altLabel'])) {
                $coll->sort($ret[$lang]['altLabel'], Collator::SORT_STRING);
            }
            if ($lang !== '') {
                $ret[$this->langToString($lang)] = $ret[$lang];
                unset($ret[$lang]);
            }
        }
        uksort($ret, 'strcoll');
        return $ret;
    }

    /**
     * Gets the values for the property in question in all other languages than the ui language.
     * @param string $property
     * @return array array of labels for the values of the given property
     */
    public function getAllLabels($property)
    {
        $labels = array();
        // shortening property labels if possible, EasyRdf requires full URIs to be in angle brackets
        $property = (EasyRdf\RdfNamespace::shorten($property) !== null) ? EasyRdf\RdfNamespace::shorten($property) : "<$property>";

        foreach ($this->resource->allLiterals($property) as $lit) {
            $labels[Punic\Language::getName($lit->getLang(), $this->getLang())][] = new ConceptPropertyValueLiteral($this->model, $this->vocab, $this->resource, $lit, $property);
        }
        ksort($labels);
        return $labels;
    }

    /**
     * Dump concept graph as JSON-LD.
     */
    public function dumpJsonLd()
    {
        $context = array(
            'skos' => EasyRdf\RdfNamespace::get("skos"),
            'isothes' => EasyRdf\RdfNamespace::get("isothes"),
            'rdfs' => EasyRdf\RdfNamespace::get("rdfs"),
            'owl' => EasyRdf\RdfNamespace::get("owl"),
            'dct' => EasyRdf\RdfNamespace::get("dcterms"),
            'dc11' => EasyRdf\RdfNamespace::get("dc11"),
            'uri' => '@id',
            'type' => '@type',
            'lang' => '@language',
            'value' => '@value',
            'graph' => '@graph',
            'label' => 'rdfs:label',
            'prefLabel' => 'skos:prefLabel',
            'altLabel' => 'skos:altLabel',
            'hiddenLabel' => 'skos:hiddenLabel',
            'broader' => 'skos:broader',
            'narrower' => 'skos:narrower',
            'related' => 'skos:related',
            'inScheme' => 'skos:inScheme',
            'schema' => EasyRdf\RdfNamespace::get("schema"),
            'wd' => EasyRdf\RdfNamespace::get("wd"),
            'wdt' => EasyRdf\RdfNamespace::get("wdt"),
        );
        $vocabPrefix = preg_replace('/\W+/', '', $this->vocab->getId()); // strip non-word characters
        $vocabUriSpace = $this->vocab->getUriSpace();

        if (!in_array($vocabUriSpace, $context, true)) {
            if (!isset($context[$vocabPrefix])) {
                $context[$vocabPrefix] = $vocabUriSpace;
            } elseif ($context[$vocabPrefix] !== $vocabUriSpace) {
                $i = 2;
                while (isset($context[$vocabPrefix . $i]) && $context[$vocabPrefix . $i] !== $vocabUriSpace) {
                    $i += 1;
                }
                $context[$vocabPrefix . $i] = $vocabUriSpace;
            }
        }
        $compactJsonLD = \ML\JsonLD\JsonLD::compact($this->graph->serialise('jsonld'), json_encode($context));
        return \ML\JsonLD\JsonLD::toString($compactJsonLD);
    }

    public function isUseModifiedDate()
    {
        return $this->getVocab()->isUseModifiedDate();
    }
}

Pull Request — main (#1918)

Concept::getXlLabel() A

Complexity

Size

Duplication

Importance

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

NatLibFi / Skosmos

Pull Request — main (#1918)

Concept::getXlLabel() A

Complexity

Size

Duplication

Importance

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

Duplication Side-by-Side

Filter issues like
