Vocabulary::getAlphabet() - Code Metrics - Inspection of "Specify SPARQL endpoint URL via environment variab..." - NatLibFi/Skosmos - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1166)

by Osma

created 2021-05-27 09:58 UTC

Vocabulary::getAlphabet() A

↳ Parent: Project

Complexity

Conditions	6
Paths	16

Size

Total Lines	25
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	17
nc	16
nop	1
dl	0
loc	25
rs	9.0777
c	0
b	0
f	0

<?php

/**
 * Vocabulary dataobjects provide access to the vocabularies on the SPARQL endpoint.
 */
class Vocabulary extends DataObject implements Modifiable
{
    /** cached value of URI space */
    private $urispace = null;
    private $config;

    public function __construct($model, $resource)
    {
        parent::__construct($model, $resource);
        $this->config = new VocabularyConfig($resource, $model->getConfig()->getGlobalPlugins());
    }

    /**
     * Returns the VocabularyConfig object
     * @return VocabularyConfig
     */
    public function getConfig()
    {
      return $this->config;
    }

    /**
     * Get the SPARQL endpoint URL for this vocabulary
     *
     * @return string endpoint URL
     */
    public function getEndpoint()
    {
        $endpoint = $this->config->getSparqlEndpoint();
        if ($endpoint === null) {
            $endpoint = $this->model->getConfig()->getDefaultEndpoint();
        }
        return $endpoint;
    }

    /**
     * Get the SPARQL graph URI for this vocabulary
     *
     * @return string|null graph URI
     */
    public function getGraph()
    {
        return $this->config->getSparqlGraph();
    }

    /**
     * Get the SPARQL implementation for this vocabulary
     *
     * @return GenericSparql SPARQL object
     */
    public function getSparql()
    {
        $endpoint = $this->getEndpoint();
        $graph = $this->getGraph();
        $dialect = $this->config->getSparqlDialect(); ?? $this->model->getConfig()->getDefaultSparqlDialect();


        return $this->model->getSparqlImplementation($dialect, $endpoint, $graph);
    }

    /**
     * Get the URI space of concepts in this vocabulary.
     *
     * @return string full URI of concept
     */
    public function getUriSpace()
    {
        if ($this->urispace === null) // initialize cache
        {
            $this->urispace = $this->resource->getLiteral('void:uriSpace')->getValue();
        }

        return $this->urispace;
    }

    /**
     * Return true if the URI is within the URI space of this vocabulary.
     *
     * @param string full URI of concept
     * @return bool true if URI is within URI namespace, false otherwise
     */

    public function containsURI($uri)
    {
        return (strpos($uri, $this->getUriSpace()) === 0);
    }

    /**
     * Get the full URI of a concept in a vocabulary. If the passed local
     * name is already a full URI, return it unchanged.
     *
     * @param $lname string local name of concept
     * @return string full URI of concept
     */
    public function getConceptURI($lname)
    {
        if (strpos($lname, 'http') === 0) {
            return $lname;
        }
        // already a full URI
        return $this->getUriSpace() . $lname;
    }

    /**
     * Asks the sparql implementation to make a label query for a uri.
     * @param string $uri
     * @param string $lang
     */
    public function getConceptLabel($uri, $lang)
    {
        return $this->getSparql()->queryLabel($uri, $lang);
    }

    /**
     * Asks the sparql implementation to make a label query for a uri.
     * @param string $uri
     * @param string $lang
     * @return array array of altLabels
     */
    public function getAllConceptLabels($uri, $lang)
    {
        return $this->getSparql()->queryAllConceptLabels($uri, $lang);
    }
    /**
     * Get the localname of a concept in the vocabulary. If the URI is not
     * in the URI space of this vocabulary, return the full URI.
     *
     * @param $uri string full URI of concept
     * @return string local name of concept, or original full URI if the local name cannot be determined
     */
    public function getLocalName($uri)
    {
        return str_replace($this->getUriSpace(), "", $uri);
    }

    /**
     * Retrieves all the information about the Vocabulary
     * from the SPARQL-endpoint.
     */
    public function getInfo($lang = null)
    {
        $ret = array();
        if (!$lang) {
            $lang = $this->getEnvLang();
        }

        // get metadata (literals only e.g. name) from vocabulary configuration file
        foreach ($this->resource->properties() as $prop) {
            foreach ($this->resource->allLiterals($prop, $lang) as $val) {
                $ret[$prop][] = $val->getValue();
            }
        }

        // also include ConceptScheme metadata from SPARQL endpoint
        $defaultcs = $this->getDefaultConceptScheme();

        // query everything the endpoint knows about the ConceptScheme
        $sparql = $this->getSparql();
        $result = $sparql->queryConceptScheme($defaultcs);
        $conceptscheme = $result->resource($defaultcs);
        $this->order = array("dc:title", "dc11:title", "skos:prefLabel", "rdfs:label", "dc:subject", "dc11:subject", "dc:description", "dc11:description", "dc:publisher", "dc11:publisher", "dc:creator", "dc11:creator", "dc:contributor", "dc:language", "dc11:language", "owl:versionInfo", "dc:source", "dc11:source");

        foreach ($conceptscheme->properties() as $prop) {
            foreach ($conceptscheme->allLiterals($prop, $lang) as $val) {
                $prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
                $ret[$prop][$val->getValue()] = $val;
            }
            if (!isset($ret[$prop]) || sizeof($ret[$prop]) == 0) { // not found with language tag
                foreach ($conceptscheme->allLiterals($prop, null) as $val) {
                    $prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
                    if ($val->getValue() instanceof DateTime) {
                        $val = Punic\Calendar::formatDate($val->getValue(), 'full', $lang) . ' ' . Punic\Calendar::format($val->getValue(), 'HH:mm:ss', $lang);
                    }
                    $ret[$prop][] = $val;
                }
            }
            foreach ($conceptscheme->allResources($prop) as $val) {
                $prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
                $exvocab = $this->model->guessVocabularyFromURI($val->getURI());
                $exlabel = $this->getExternalLabel($exvocab, $val->getURI(), $lang);
                if (isset($exlabel)) {
                    $val->add('skosmos:vocab', $exvocab->getId());
                    $val->add('skosmos:label', $exlabel);
                }
                $label = $val->label($lang) ? $val->label($lang)->getValue() : $val->getUri();
                $ret[$prop][$exlabel ? $exlabel->getValue() : $label] = $val;
            }
            if (isset($ret[$prop])) {
                ksort($ret[$prop]);
            }
        }
        if (isset($ret['owl:versionInfo'])) { // if version info available for vocabulary convert it to a more readable format
            $ret['owl:versionInfo'][0] = $this->parseVersionInfo($ret['owl:versionInfo'][0]);
        }
        // remove duplicate values
        foreach (array_keys($ret) as $prop) {
            $ret[$prop] = array_unique($ret[$prop]);
        }

        $ret = $this->arbitrarySort($ret);

        // filtering multiple labels
        if (isset($ret['dc:title'])) {
            unset($ret['dc11:title'], $ret['skos:prefLabel'], $ret['rdfs:label']);
        } else if (isset($ret['dc11:title'])) {
            unset($ret['skos:prefLabel'], $ret['rdfs:label']);
        } else if (isset($ret['skos:prefLabel'])) {
            unset($ret['rdfs:label']);
        }

        return $ret;
    }

    /**
     * Return all concept schemes in the vocabulary.
     * @return array Array with concept scheme URIs (string) as keys and labels (string) as values
     */

    public function getConceptSchemes($lang = '')
    {
        if ($lang === '') {
            $lang = $this->getEnvLang();
        }

        return $this->getSparql()->queryConceptSchemes($lang);
    }

    /**
     * Return the URI of the default concept scheme of this vocabulary. If the skosmos:mainConceptScheme property is set in the
     * vocabulary configuration, that will be returned. Otherwise an arbitrary concept scheme will be returned.
     * @return string concept scheme URI
     */

    public function getDefaultConceptScheme()
    {
        $conceptScheme = $this->config->getMainConceptSchemeURI();
        if ($conceptScheme) {
            return $conceptScheme;
        }

        // mainConceptScheme not explicitly set, guess it
        $conceptSchemes = $this->getConceptSchemes();
        $conceptSchemeURIs = array_keys($conceptSchemes);
        // return the URI of the last concept scheme
        return array_pop($conceptSchemeURIs);
    }

    /**
     * Returns the main Concept Scheme of that Vocabulary, or null if not set.
     * @param string $defaultConceptSchemeURI default concept scheme URI
     * @return \EasyRdf\Graph|mixed
     */
    public function getConceptScheme(string $defaultConceptSchemeURI)
    {
        return $this->getSparql()->queryConceptScheme($defaultConceptSchemeURI);
    }

    /**
     * Return the top concepts of a concept scheme in the vocabulary.
     * @param string $conceptScheme URI of concept scheme whose top concepts to return. If not set,
     *                              the default concept scheme of the vocabulary will be used.
     * @param string $lang preferred language for the concept labels,
     * @return array Array with concept URIs (string) as keys and labels (string) as values
     */

    public function getTopConcepts($conceptScheme = null, $lang = '')
    {
        if ($lang === '') {
            $lang = $this->getEnvLang();
        }
        $fallback = $this->config->getDefaultLanguage();

        if ($conceptScheme === null || $conceptScheme == '') {
            $conceptScheme = $this->getDefaultConceptScheme();
        }

        return $this->getSparql()->queryTopConcepts($conceptScheme, $lang, $fallback);
    }

    /**
     * Tries to parse version, date and time from sparql version information into a readable format.
     * @param string $version
     * @return string
     */
    private function parseVersionInfo($version)
    {
        $parts = explode(' ', $version);
        if ($parts[0] != '$Id:') {
            return $version;
        }
        // don't know how to parse
        $rev = $parts[2];
        $datestr = $parts[3] . ' ' . $parts[4];

        return "$datestr (r$rev)";
    }

    /**
     * Counts the statistics of the vocabulary.
     * @return Array containing the label counts
     */
    public function getStatistics($lang = '', $array=null, $group=null)
    {
        $sparql = $this->getSparql();
        // find the number of concepts
        return $sparql->countConcepts($lang, $array, $group);
    }

    /**
     * Counts the statistics of the vocabulary.
     * @return array of the concept counts in different languages
     */
    public function getLabelStatistics()
    {
        $sparql = $this->getSparql();
        $ret = array();
        // count the number of different types of concepts in all languages
        $ret['terms'] = $sparql->countLangConcepts($this->config->getLanguages(), $this->config->getIndexClasses());

        return $ret;
    }

    /**
     * Gets the parent concepts of a concept and child concepts for all of those.
     * @param string $uri
     * @param string $lang language identifier.
     */
    public function getConceptHierarchy($uri, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        $fallback = count($this->config->getLanguageOrder($lang)) > 1 ? $this->config->getLanguageOrder($lang)[1] : $this->config->getDefaultLanguage();
        $props = $this->config->getHierarchyProperty();
        return $this->getSparql()->queryParentList($uri, $lang, $fallback, $props);
    }

    /**
     * Gets the child relations of a concept and whether these children have more children.
     * @param string $uri
     */
    public function getConceptChildren($uri, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        $fallback = count($this->config->getLanguageOrder($lang)) > 1 ? $this->config->getLanguageOrder($lang)[1] : $this->config->getDefaultLanguage();
        $props = $this->config->getHierarchyProperty();
        return $this->getSparql()->queryChildren($uri, $lang, $fallback, $props);
    }

    /**
     * Gets the skos:narrower relations of a concept.
     * @param string $uri
     * @param string $lang language identifier.
     */
    public function getConceptNarrowers($uri, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        return $this->getSparql()->queryProperty($uri, 'skos:narrower', $lang);
    }

    /**
     * Gets the skos:narrowerTransitive relations of a concept.
     * @param string $uri
     * @param integer $limit
     * @param string $lang language identifier.
     */
    public function getConceptTransitiveNarrowers($uri, $limit, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        return $this->getSparql()->queryTransitiveProperty($uri, array('skos:narrower'), $lang, $limit);
    }

    /**
     * Gets the skos:broader relations of a concept.
     * @param string $uri
     * @param string $lang language identifier.
     */
    public function getConceptBroaders($uri, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        return $this->getSparql()->queryProperty($uri, 'skos:broader', $lang);
    }

    /**
     * Gets the skos:broaderTransitive relations of a concept.
     * @param string $uri
     * @param integer $limit
     * @param boolean $any set to true if you want to have a label even in case of a correct language one missing.
     * @param string $lang language identifier.
     */
    public function getConceptTransitiveBroaders($uri, $limit, $any = false, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        $fallback = $this->config->getDefaultLanguage();
        return $this->getSparql()->queryTransitiveProperty($uri, array('skos:broader'), $lang, $limit, $any, $fallback);
    }

    /**
     * Gets all the skos:related concepts of a concept.
     * @param string $uri
     * @param string $lang language identifier.
     */
    public function getConceptRelateds($uri, $lang)
    {
        $lang = $lang ? $lang : $this->getEnvLang();
        return $this->getSparql()->queryProperty($uri, 'skos:related', $lang);
    }

    /**
     * Makes a query into the sparql endpoint for a concept.
     * @param string $uri the full URI of the concept
     * @return Concept[]
     */
    public function getConceptInfo($uri, $clang)
    {
        $sparql = $this->getSparql();

        return $sparql->queryConceptInfo($uri, $this->config->getArrayClassURI(), array($this), $clang);
    }

    /**
     * Lists the different concept groups available in the vocabulary.
     * @param string $clang content language parameter
     * @return array
     */
    public function listConceptGroups($clang = null)
    {
        if ($clang === null || $clang == '') {
            $clang = $this->getEnvLang();
        }

        $ret = array();
        $gclass = $this->config->getGroupClassURI();
        if ($gclass === null) {
            return $ret;
        }
        // no group class defined, so empty result
        $groups = $this->getSparql()->listConceptGroups($gclass, $clang);
        foreach ($groups as $uri => $label) {
            $ret[$uri] = $label;
        }

        return $ret;
    }

    /**
     * Lists the concepts available in the concept group.
     * @param $clname
     * @return array
     */
    public function listConceptGroupContents($glname, $clang)
    {
        if (!$clang) {
            $clang = $this->config->getEnvLang();
        }

        $ret = array();
        $gclass = $this->config->getGroupClassURI();
        if ($gclass === null) {
            return $ret;
        }
        // no group class defined, so empty result
        $group = $this->getConceptURI($glname);
        $contents = $this->getSparql()->listConceptGroupContents($gclass, $group, $clang, $this->config->getShowDeprecated());
        foreach ($contents as $uri => $label) {
            $ret[$uri] = $label;
        }

        return $ret;
    }

    /**
     * Returns the letters of the alphabet which have been used in this vocabulary.
     * The returned letters may also include specials such as '0-9' (digits) and '!*' (special characters).
     * @param $clang content language
     * @return array array of letters
     */
    public function getAlphabet($clang)
    {
        $chars = $this->getSparql()->queryFirstCharacters($clang, $this->config->getIndexClasses());
        $letters = array();
        $digits = false;
        $specials = false;
        foreach ($chars as $char) {
            if (preg_match('/\p{L}/u', $char)) {
                $letters[] = $char;
            } elseif (preg_match('/\d/u', $char)) {
                $digits = true;
            } else {
                $specials = true;
            }
        }
        usort($letters, 'strcoll');
        if ($specials) {
            $letters[] = '!*';
        }

        if ($digits) {
            $letters[] = '0-9';
        }

        return $letters;
    }

    /**
     * Searches for concepts with a label starting with the specified letter.
     * Also the special tokens '0-9' (digits), '!*' (special characters) and '*'
     * (everything) are supported.
     * @param $letter letter (or special token) to search for
     */
    public function searchConceptsAlphabetical($letter, $limit = null, $offset = null, $clang = null)
    {
        return $this->getSparql()->queryConceptsAlphabetical($letter, $clang, $limit, $offset, $this->config->getIndexClasses(), $this->config->getShowDeprecated(), $this->config->getAlphabeticalListQualifier());
    }

    /**
     * Makes a query for the transitive broaders of a concept and returns the concepts hierarchy processed for the view.
     * @param string $lang
     * @param string $uri
     */
    public function getBreadCrumbs($lang, $uri)
    {
        $broaders = $this->getConceptTransitiveBroaders($uri, 1000, true, $lang);
        $origCrumbs = $this->getCrumbs($broaders, $uri);
        return $this->combineCrumbs($origCrumbs);
    }

    /**
     * Takes the crumbs as a parameter and combines the crumbs if the path they form is too long.
     * @return array
     */
    private function combineCrumbs($origCrumbs)
    {
        $combined = array();
        foreach ($origCrumbs as $pathKey => $path) {
            $firstToCombine = true;
            $combinedPath = array();
            foreach ($path as $crumbKey => $crumb) {
                if ($crumb->getPrefLabel() === '...') {
                    array_push($combinedPath, $crumb);
                    if ($firstToCombine) {
                        $firstToCombine = false;
                    } else {
                        unset($origCrumbs[$pathKey][$crumbKey]);
                    }
                }
            }
            $combined[] = $combinedPath;
        }

        return array('combined' => $combined, 'breadcrumbs' => $origCrumbs);
    }

    /**
     * Recursive function for building the breadcrumb paths for the view.
     * @param array $bTresult contains the results of the broaderTransitive query.
     * @param string $uri
     * @param array $path
     */
    private function getCrumbs($bTresult, $uri, $path = null)
    {
        $crumbs = array();
        if (!isset($path)) {
            $path = array();
        }

        // check that there is no cycle (issue #220)
        foreach ($path as $childcrumb) {
            if ($childcrumb->getUri() == $uri) {
                // found a cycle - short-circuit and stop
                return $crumbs;
            }
        }
        if (isset($bTresult[$uri]['direct'])) {
            foreach ($bTresult[$uri]['direct'] as $broaderUri) {
                $newpath = array_merge($path, array(new Breadcrumb($uri, $bTresult[$uri]['label'])));
                if ($uri !== $broaderUri) {
                    $crumbs = array_merge($crumbs, $this->getCrumbs($bTresult, $broaderUri, $newpath));
                }
            }
        } else { // we have reached the end of a path and we need to start a new row in the 'stack'
            if (isset($bTresult[$uri])) {
                $path = array_merge($path, array(new Breadcrumb($uri, $bTresult[$uri]['label'])));
            }

            $index = 1;
            $length = sizeof($path);
            $limit = $length - 5;
            foreach ($path as $crumb) {
                if ($length > 5 && $index > $length - $limit) { // displays 5 concepts closest to the concept.
                    $crumb->hideLabel();
                }
                $index++;
            }
            $crumbs[] = array_reverse($path);
        }
        return $crumbs;
    }

    /**
     * Verify that the requested language is supported by the vocabulary. If not, returns
     * the default language of the vocabulary.
     * @param string $lang language to check
     * @return string language tag that is supported by the vocabulary
     */

    public function verifyVocabularyLanguage($lang)
    {
        return (in_array($lang, $this->config->getLanguages())) ? $lang : $this->config->getDefaultLanguage();
    }

    /**
     * Returns a list of recently changed or entirely new concepts.
     * @param string $prop the property uri pointing to timestamps, eg. 'dc:modified'
     * @param string $clang content language for the labels
     * @param int $offset starting index offset
     * @param int $limit maximum number of concepts to return
     * @return Array
     */
    public function getChangeList($prop, $clang, $offset, $limit)
    {
      return $this->getSparql()->queryChangeList($prop, $clang, $offset, $limit);
    }

    public function getTitle($lang=null) {
      return $this->config->getTitle($lang);
    }

    public function getShortName() {
      return $this->config->getShortName();
    }

    public function getId() {
      return $this->config->getId();
    }

    public function getModifiedDate()
    {
        $modifiedDate = null;

        $conceptSchemeURI = $this->getDefaultConceptScheme();
        if ($conceptSchemeURI) {
            $conceptSchemeGraph = $this->getConceptScheme($conceptSchemeURI);
            if (!$conceptSchemeGraph->isEmpty()) {
                $literal = $conceptSchemeGraph->getLiteral($conceptSchemeURI, "dc:modified");
                if ($literal) {
                    $modifiedDate = $literal->getValue();
                }
            }
        }

        return $modifiedDate;
    }

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


1			<?php
2
3			/**
4			* Vocabulary dataobjects provide access to the vocabularies on the SPARQL endpoint.
5			*/
6			class Vocabulary extends DataObject implements Modifiable
7			{
8			/** cached value of URI space */
9			private $urispace = null;
10			private $config;
11
12			public function __construct($model, $resource)
13			{
14			parent::__construct($model, $resource);
15			$this->config = new VocabularyConfig($resource, $model->getConfig()->getGlobalPlugins());
16			}
17
18			/**
19			* Returns the VocabularyConfig object
20			* @return VocabularyConfig
21			*/
22			public function getConfig()
23			{
24			return $this->config;
25			}
26
27			/**
28			* Get the SPARQL endpoint URL for this vocabulary
29			*
30			* @return string endpoint URL
31			*/
32			public function getEndpoint()
33			{
34			$endpoint = $this->config->getSparqlEndpoint();
35			if ($endpoint === null) {
36			$endpoint = $this->model->getConfig()->getDefaultEndpoint();
37			}
38			return $endpoint;
39			}
40
41			/**
42			* Get the SPARQL graph URI for this vocabulary
43			*
44			* @return string\|null graph URI
45			*/
46			public function getGraph()
47			{
48			return $this->config->getSparqlGraph();
49			}
50
51			/**
52			* Get the SPARQL implementation for this vocabulary
53			*
54			* @return GenericSparql SPARQL object
55			*/
56			public function getSparql()
57			{
58			$endpoint = $this->getEndpoint();
59			$graph = $this->getGraph();
60			$dialect = $this->config->getSparqlDialect(); ?? $this->model->getConfig()->getDefaultSparqlDialect();
			0 ignored issues – show Bug introduced 2021-05-27 10:00 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_COALESCE on line 60 at column 54 Loading history...
61
62			return $this->model->getSparqlImplementation($dialect, $endpoint, $graph);
63			}
64
65			/**
66			* Get the URI space of concepts in this vocabulary.
67			*
68			* @return string full URI of concept
69			*/
70			public function getUriSpace()
71			{
72			if ($this->urispace === null) // initialize cache
73			{
74			$this->urispace = $this->resource->getLiteral('void:uriSpace')->getValue();
75			}
76
77			return $this->urispace;
78			}
79
80			/**
81			* Return true if the URI is within the URI space of this vocabulary.
82			*
83			* @param string full URI of concept
84			* @return bool true if URI is within URI namespace, false otherwise
85			*/
86
87			public function containsURI($uri)
88			{
89			return (strpos($uri, $this->getUriSpace()) === 0);
90			}
91
92			/**
93			* Get the full URI of a concept in a vocabulary. If the passed local
94			* name is already a full URI, return it unchanged.
95			*
96			* @param $lname string local name of concept
97			* @return string full URI of concept
98			*/
99			public function getConceptURI($lname)
100			{
101			if (strpos($lname, 'http') === 0) {
102			return $lname;
103			}
104			// already a full URI
105			return $this->getUriSpace() . $lname;
106			}
107
108			/**
109			* Asks the sparql implementation to make a label query for a uri.
110			* @param string $uri
111			* @param string $lang
112			*/
113			public function getConceptLabel($uri, $lang)
114			{
115			return $this->getSparql()->queryLabel($uri, $lang);
116			}
117
118			/**
119			* Asks the sparql implementation to make a label query for a uri.
120			* @param string $uri
121			* @param string $lang
122			* @return array array of altLabels
123			*/
124			public function getAllConceptLabels($uri, $lang)
125			{
126			return $this->getSparql()->queryAllConceptLabels($uri, $lang);
127			}
128			/**
129			* Get the localname of a concept in the vocabulary. If the URI is not
130			* in the URI space of this vocabulary, return the full URI.
131			*
132			* @param $uri string full URI of concept
133			* @return string local name of concept, or original full URI if the local name cannot be determined
134			*/
135			public function getLocalName($uri)
136			{
137			return str_replace($this->getUriSpace(), "", $uri);
138			}
139
140			/**
141			* Retrieves all the information about the Vocabulary
142			* from the SPARQL-endpoint.
143			*/
144			public function getInfo($lang = null)
145			{
146			$ret = array();
147			if (!$lang) {
148			$lang = $this->getEnvLang();
149			}
150
151			// get metadata (literals only e.g. name) from vocabulary configuration file
152			foreach ($this->resource->properties() as $prop) {
153			foreach ($this->resource->allLiterals($prop, $lang) as $val) {
154			$ret[$prop][] = $val->getValue();
155			}
156			}
157
158			// also include ConceptScheme metadata from SPARQL endpoint
159			$defaultcs = $this->getDefaultConceptScheme();
160
161			// query everything the endpoint knows about the ConceptScheme
162			$sparql = $this->getSparql();
163			$result = $sparql->queryConceptScheme($defaultcs);
164			$conceptscheme = $result->resource($defaultcs);
165			$this->order = array("dc:title", "dc11:title", "skos:prefLabel", "rdfs:label", "dc:subject", "dc11:subject", "dc:description", "dc11:description", "dc:publisher", "dc11:publisher", "dc:creator", "dc11:creator", "dc:contributor", "dc:language", "dc11:language", "owl:versionInfo", "dc:source", "dc11:source");
166
167			foreach ($conceptscheme->properties() as $prop) {
168			foreach ($conceptscheme->allLiterals($prop, $lang) as $val) {
169			$prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
170			$ret[$prop][$val->getValue()] = $val;
171			}
172			if (!isset($ret[$prop]) \|\| sizeof($ret[$prop]) == 0) { // not found with language tag
173			foreach ($conceptscheme->allLiterals($prop, null) as $val) {
174			$prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
175			if ($val->getValue() instanceof DateTime) {
176			$val = Punic\Calendar::formatDate($val->getValue(), 'full', $lang) . ' ' . Punic\Calendar::format($val->getValue(), 'HH:mm:ss', $lang);
177			}
178			$ret[$prop][] = $val;
179			}
180			}
181			foreach ($conceptscheme->allResources($prop) as $val) {
182			$prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
183			$exvocab = $this->model->guessVocabularyFromURI($val->getURI());
184			$exlabel = $this->getExternalLabel($exvocab, $val->getURI(), $lang);
185			if (isset($exlabel)) {
186			$val->add('skosmos:vocab', $exvocab->getId());
187			$val->add('skosmos:label', $exlabel);
188			}
189			$label = $val->label($lang) ? $val->label($lang)->getValue() : $val->getUri();
190			$ret[$prop][$exlabel ? $exlabel->getValue() : $label] = $val;
191			}
192			if (isset($ret[$prop])) {
193			ksort($ret[$prop]);
194			}
195			}
196			if (isset($ret['owl:versionInfo'])) { // if version info available for vocabulary convert it to a more readable format
197			$ret['owl:versionInfo'][0] = $this->parseVersionInfo($ret['owl:versionInfo'][0]);
198			}
199			// remove duplicate values
200			foreach (array_keys($ret) as $prop) {
201			$ret[$prop] = array_unique($ret[$prop]);
202			}
203
204			$ret = $this->arbitrarySort($ret);
205
206			// filtering multiple labels
207			if (isset($ret['dc:title'])) {
208			unset($ret['dc11:title'], $ret['skos:prefLabel'], $ret['rdfs:label']);
209			} else if (isset($ret['dc11:title'])) {
210			unset($ret['skos:prefLabel'], $ret['rdfs:label']);
211			} else if (isset($ret['skos:prefLabel'])) {
212			unset($ret['rdfs:label']);
213			}
214
215			return $ret;
216			}
217
218			/**
219			* Return all concept schemes in the vocabulary.
220			* @return array Array with concept scheme URIs (string) as keys and labels (string) as values
221			*/
222
223			public function getConceptSchemes($lang = '')
224			{
225			if ($lang === '') {
226			$lang = $this->getEnvLang();
227			}
228
229			return $this->getSparql()->queryConceptSchemes($lang);
230			}
231
232			/**
233			* Return the URI of the default concept scheme of this vocabulary. If the skosmos:mainConceptScheme property is set in the
234			* vocabulary configuration, that will be returned. Otherwise an arbitrary concept scheme will be returned.
235			* @return string concept scheme URI
236			*/
237
238			public function getDefaultConceptScheme()
239			{
240			$conceptScheme = $this->config->getMainConceptSchemeURI();
241			if ($conceptScheme) {
242			return $conceptScheme;
243			}
244
245			// mainConceptScheme not explicitly set, guess it
246			$conceptSchemes = $this->getConceptSchemes();
247			$conceptSchemeURIs = array_keys($conceptSchemes);
248			// return the URI of the last concept scheme
249			return array_pop($conceptSchemeURIs);
250			}
251
252			/**
253			* Returns the main Concept Scheme of that Vocabulary, or null if not set.
254			* @param string $defaultConceptSchemeURI default concept scheme URI
255			* @return \EasyRdf\Graph\|mixed
256			*/
257			public function getConceptScheme(string $defaultConceptSchemeURI)
258			{
259			return $this->getSparql()->queryConceptScheme($defaultConceptSchemeURI);
260			}
261
262			/**
263			* Return the top concepts of a concept scheme in the vocabulary.
264			* @param string $conceptScheme URI of concept scheme whose top concepts to return. If not set,
265			* the default concept scheme of the vocabulary will be used.
266			* @param string $lang preferred language for the concept labels,
267			* @return array Array with concept URIs (string) as keys and labels (string) as values
268			*/
269
270			public function getTopConcepts($conceptScheme = null, $lang = '')
271			{
272			if ($lang === '') {
273			$lang = $this->getEnvLang();
274			}
275			$fallback = $this->config->getDefaultLanguage();
276
277			if ($conceptScheme === null \|\| $conceptScheme == '') {
278			$conceptScheme = $this->getDefaultConceptScheme();
279			}
280
281			return $this->getSparql()->queryTopConcepts($conceptScheme, $lang, $fallback);
282			}
283
284			/**
285			* Tries to parse version, date and time from sparql version information into a readable format.
286			* @param string $version
287			* @return string
288			*/
289			private function parseVersionInfo($version)
290			{
291			$parts = explode(' ', $version);
292			if ($parts[0] != '$Id:') {
293			return $version;
294			}
295			// don't know how to parse
296			$rev = $parts[2];
297			$datestr = $parts[3] . ' ' . $parts[4];
298
299			return "$datestr (r$rev)";
300			}
301
302			/**
303			* Counts the statistics of the vocabulary.
304			* @return Array containing the label counts
305			*/
306			public function getStatistics($lang = '', $array=null, $group=null)
307			{
308			$sparql = $this->getSparql();
309			// find the number of concepts
310			return $sparql->countConcepts($lang, $array, $group);
311			}
312
313			/**
314			* Counts the statistics of the vocabulary.
315			* @return array of the concept counts in different languages
316			*/
317			public function getLabelStatistics()
318			{
319			$sparql = $this->getSparql();
320			$ret = array();
321			// count the number of different types of concepts in all languages
322			$ret['terms'] = $sparql->countLangConcepts($this->config->getLanguages(), $this->config->getIndexClasses());
323
324			return $ret;
325			}
326
327			/**
328			* Gets the parent concepts of a concept and child concepts for all of those.
329			* @param string $uri
330			* @param string $lang language identifier.
331			*/
332			public function getConceptHierarchy($uri, $lang)
333			{
334			$lang = $lang ? $lang : $this->getEnvLang();
335			$fallback = count($this->config->getLanguageOrder($lang)) > 1 ? $this->config->getLanguageOrder($lang)[1] : $this->config->getDefaultLanguage();
336			$props = $this->config->getHierarchyProperty();
337			return $this->getSparql()->queryParentList($uri, $lang, $fallback, $props);
338			}
339
340			/**
341			* Gets the child relations of a concept and whether these children have more children.
342			* @param string $uri
343			*/
344			public function getConceptChildren($uri, $lang)
345			{
346			$lang = $lang ? $lang : $this->getEnvLang();
347			$fallback = count($this->config->getLanguageOrder($lang)) > 1 ? $this->config->getLanguageOrder($lang)[1] : $this->config->getDefaultLanguage();
348			$props = $this->config->getHierarchyProperty();
349			return $this->getSparql()->queryChildren($uri, $lang, $fallback, $props);
350			}
351
352			/**
353			* Gets the skos:narrower relations of a concept.
354			* @param string $uri
355			* @param string $lang language identifier.
356			*/
357			public function getConceptNarrowers($uri, $lang)
358			{
359			$lang = $lang ? $lang : $this->getEnvLang();
360			return $this->getSparql()->queryProperty($uri, 'skos:narrower', $lang);
361			}
362
363			/**
364			* Gets the skos:narrowerTransitive relations of a concept.
365			* @param string $uri
366			* @param integer $limit
367			* @param string $lang language identifier.
368			*/
369			public function getConceptTransitiveNarrowers($uri, $limit, $lang)
370			{
371			$lang = $lang ? $lang : $this->getEnvLang();
372			return $this->getSparql()->queryTransitiveProperty($uri, array('skos:narrower'), $lang, $limit);
373			}
374
375			/**
376			* Gets the skos:broader relations of a concept.
377			* @param string $uri
378			* @param string $lang language identifier.
379			*/
380			public function getConceptBroaders($uri, $lang)
381			{
382			$lang = $lang ? $lang : $this->getEnvLang();
383			return $this->getSparql()->queryProperty($uri, 'skos:broader', $lang);
384			}
385
386			/**
387			* Gets the skos:broaderTransitive relations of a concept.
388			* @param string $uri
389			* @param integer $limit
390			* @param boolean $any set to true if you want to have a label even in case of a correct language one missing.
391			* @param string $lang language identifier.
392			*/
393			public function getConceptTransitiveBroaders($uri, $limit, $any = false, $lang)
394			{
395			$lang = $lang ? $lang : $this->getEnvLang();
396			$fallback = $this->config->getDefaultLanguage();
397			return $this->getSparql()->queryTransitiveProperty($uri, array('skos:broader'), $lang, $limit, $any, $fallback);
398			}
399
400			/**
401			* Gets all the skos:related concepts of a concept.
402			* @param string $uri
403			* @param string $lang language identifier.
404			*/
405			public function getConceptRelateds($uri, $lang)
406			{
407			$lang = $lang ? $lang : $this->getEnvLang();
408			return $this->getSparql()->queryProperty($uri, 'skos:related', $lang);
409			}
410
411			/**
412			* Makes a query into the sparql endpoint for a concept.
413			* @param string $uri the full URI of the concept
414			* @return Concept[]
415			*/
416			public function getConceptInfo($uri, $clang)
417			{
418			$sparql = $this->getSparql();
419
420			return $sparql->queryConceptInfo($uri, $this->config->getArrayClassURI(), array($this), $clang);
421			}
422
423			/**
424			* Lists the different concept groups available in the vocabulary.
425			* @param string $clang content language parameter
426			* @return array
427			*/
428			public function listConceptGroups($clang = null)
429			{
430			if ($clang === null \|\| $clang == '') {
431			$clang = $this->getEnvLang();
432			}
433
434			$ret = array();
435			$gclass = $this->config->getGroupClassURI();
436			if ($gclass === null) {
437			return $ret;
438			}
439			// no group class defined, so empty result
440			$groups = $this->getSparql()->listConceptGroups($gclass, $clang);
441			foreach ($groups as $uri => $label) {
442			$ret[$uri] = $label;
443			}
444
445			return $ret;
446			}
447
448			/**
449			* Lists the concepts available in the concept group.
450			* @param $clname
451			* @return array
452			*/
453			public function listConceptGroupContents($glname, $clang)
454			{
455			if (!$clang) {
456			$clang = $this->config->getEnvLang();
457			}
458
459			$ret = array();
460			$gclass = $this->config->getGroupClassURI();
461			if ($gclass === null) {
462			return $ret;
463			}
464			// no group class defined, so empty result
465			$group = $this->getConceptURI($glname);
466			$contents = $this->getSparql()->listConceptGroupContents($gclass, $group, $clang, $this->config->getShowDeprecated());
467			foreach ($contents as $uri => $label) {
468			$ret[$uri] = $label;
469			}
470
471			return $ret;
472			}
473
474			/**
475			* Returns the letters of the alphabet which have been used in this vocabulary.
476			* The returned letters may also include specials such as '0-9' (digits) and '!*' (special characters).
477			* @param $clang content language
478			* @return array array of letters
479			*/
480			public function getAlphabet($clang)
481			{
482			$chars = $this->getSparql()->queryFirstCharacters($clang, $this->config->getIndexClasses());
483			$letters = array();
484			$digits = false;
485			$specials = false;
486			foreach ($chars as $char) {
487			if (preg_match('/\p{L}/u', $char)) {
488			$letters[] = $char;
489			} elseif (preg_match('/\d/u', $char)) {
490			$digits = true;
491			} else {
492			$specials = true;
493			}
494			}
495			usort($letters, 'strcoll');
496			if ($specials) {
497			$letters[] = '!*';
498			}
499
500			if ($digits) {
501			$letters[] = '0-9';
502			}
503
504			return $letters;
505			}
506
507			/**
508			* Searches for concepts with a label starting with the specified letter.
509			* Also the special tokens '0-9' (digits), '!' (special characters) and ''
510			* (everything) are supported.
511			* @param $letter letter (or special token) to search for
512			*/
513			public function searchConceptsAlphabetical($letter, $limit = null, $offset = null, $clang = null)
514			{
515			return $this->getSparql()->queryConceptsAlphabetical($letter, $clang, $limit, $offset, $this->config->getIndexClasses(), $this->config->getShowDeprecated(), $this->config->getAlphabeticalListQualifier());
516			}
517
518			/**
519			* Makes a query for the transitive broaders of a concept and returns the concepts hierarchy processed for the view.
520			* @param string $lang
521			* @param string $uri
522			*/
523			public function getBreadCrumbs($lang, $uri)
524			{
525			$broaders = $this->getConceptTransitiveBroaders($uri, 1000, true, $lang);
526			$origCrumbs = $this->getCrumbs($broaders, $uri);
527			return $this->combineCrumbs($origCrumbs);
528			}
529
530			/**
531			* Takes the crumbs as a parameter and combines the crumbs if the path they form is too long.
532			* @return array
533			*/
534			private function combineCrumbs($origCrumbs)
535			{
536			$combined = array();
537			foreach ($origCrumbs as $pathKey => $path) {
538			$firstToCombine = true;
539			$combinedPath = array();
540			foreach ($path as $crumbKey => $crumb) {
541			if ($crumb->getPrefLabel() === '...') {
542			array_push($combinedPath, $crumb);
543			if ($firstToCombine) {
544			$firstToCombine = false;
545			} else {
546			unset($origCrumbs[$pathKey][$crumbKey]);
547			}
548			}
549			}
550			$combined[] = $combinedPath;
551			}
552
553			return array('combined' => $combined, 'breadcrumbs' => $origCrumbs);
554			}
555
556			/**
557			* Recursive function for building the breadcrumb paths for the view.
558			* @param array $bTresult contains the results of the broaderTransitive query.
559			* @param string $uri
560			* @param array $path
561			*/
562			private function getCrumbs($bTresult, $uri, $path = null)
563			{
564			$crumbs = array();
565			if (!isset($path)) {
566			$path = array();
567			}
568
569			// check that there is no cycle (issue #220)
570			foreach ($path as $childcrumb) {
571			if ($childcrumb->getUri() == $uri) {
572			// found a cycle - short-circuit and stop
573			return $crumbs;
574			}
575			}
576			if (isset($bTresult[$uri]['direct'])) {
577			foreach ($bTresult[$uri]['direct'] as $broaderUri) {
578			$newpath = array_merge($path, array(new Breadcrumb($uri, $bTresult[$uri]['label'])));
579			if ($uri !== $broaderUri) {
580			$crumbs = array_merge($crumbs, $this->getCrumbs($bTresult, $broaderUri, $newpath));
581			}
582			}
583			} else { // we have reached the end of a path and we need to start a new row in the 'stack'
584			if (isset($bTresult[$uri])) {
585			$path = array_merge($path, array(new Breadcrumb($uri, $bTresult[$uri]['label'])));
586			}
587
588			$index = 1;
589			$length = sizeof($path);
590			$limit = $length - 5;
591			foreach ($path as $crumb) {
592			if ($length > 5 && $index > $length - $limit) { // displays 5 concepts closest to the concept.
593			$crumb->hideLabel();
594			}
595			$index++;
596			}
597			$crumbs[] = array_reverse($path);
598			}
599			return $crumbs;
600			}
601
602			/**
603			* Verify that the requested language is supported by the vocabulary. If not, returns
604			* the default language of the vocabulary.
605			* @param string $lang language to check
606			* @return string language tag that is supported by the vocabulary
607			*/
608
609			public function verifyVocabularyLanguage($lang)
610			{
611			return (in_array($lang, $this->config->getLanguages())) ? $lang : $this->config->getDefaultLanguage();
612			}
613
614			/**
615			* Returns a list of recently changed or entirely new concepts.
616			* @param string $prop the property uri pointing to timestamps, eg. 'dc:modified'
617			* @param string $clang content language for the labels
618			* @param int $offset starting index offset
619			* @param int $limit maximum number of concepts to return
620			* @return Array
621			*/
622			public function getChangeList($prop, $clang, $offset, $limit)
623			{
624			return $this->getSparql()->queryChangeList($prop, $clang, $offset, $limit);
625			}
626
627			public function getTitle($lang=null) {
628			return $this->config->getTitle($lang);
629			}
630
631			public function getShortName() {
632			return $this->config->getShortName();
633			}
634
635			public function getId() {
636			return $this->config->getId();
637			}
638
639			public function getModifiedDate()
640			{
641			$modifiedDate = null;
642
643			$conceptSchemeURI = $this->getDefaultConceptScheme();
644			if ($conceptSchemeURI) {
645			$conceptSchemeGraph = $this->getConceptScheme($conceptSchemeURI);
646			if (!$conceptSchemeGraph->isEmpty()) {
647			$literal = $conceptSchemeGraph->getLiteral($conceptSchemeURI, "dc:modified");
648			if ($literal) {
649			$modifiedDate = $literal->getValue();
650			}
651			}
652			}
653
654			return $modifiedDate;
655			}
656
657			public function isUseModifiedDate()
658			{
659			return $this->getConfig()->isUseModifiedDate();
660			}
661			}
662

NatLibFi / Skosmos

Pull Request — master (#1166)

Vocabulary::getAlphabet() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like