Documentation

PropertyDesc extends BaseDesc
in package

A container for an RDF property description

Tags
author

zozlak

Table of Contents

Properties

$automatedFill  : bool
achd:automatedFill annotation property value
$comment  : array<string|int, string>
Associative array of rdfs:comment values (langauge as a key)
$defaultValue  : string|null
acdh:defaultValue annotation property value
$domain  : array<string|int, string>
Property domain URI
$exampleValue  : array<string, string>
acdh:exampleValue annotation property values
$id  : int|null
Internal id of a corresponding repository resource
$label  : array<string|int, string>
Associative array of label values (langauge as a key)
$langTag  : bool
is property range http://www.w3.org/1999/02/22-rdf-syntax-ns#langString
$max  : int|null
Maximum count
$min  : int|null
Minimum count
$ordering  : int
achd:ordering annotation property value
$properties  : array<string|int, string>
Property URIs of all properties this one inhertis from (includint itself)
$property  : array<string|int, string>
Property URIs
$range  : array<string|int, string>
Property range URI
$recommendedClass  : bool
If a class is among acdh:recommendedClass for this property.
$type  : string
Property type URI (owl:DatatypeProperty or owl:ObjectProperty)
$uri  : string|null
The ontology entity URI within the ontology namespace
$vocabs  : string
acdh:vocabs annotation property value
$ontologyObj  : Ontology
$vocabularyValues  : array<string|int, SkosConceptDesc>
Array of vocabulary values fetched from vocabulary pointed by acdh:vocabs annotation property

Methods

__construct()  : mixed
__get()  : mixed
__sleep()  : array<string|int, mixed>
checkVocabularyValue()  : string|bool
Checks if a given value exists in a given vocabulary.
getComment()  : string
getLabel()  : string
getVocabularyValue()  : SkosConceptDesc|null
Fetches SkosConceptDesc object desribing a vocabulary value.
getVocabularyValues()  : array<string|int, SkosConceptDesc>
Returns a list of vocabulary values sorted according to the label property value in a given language.
setOntology()  : void
setOntologyObject()  : void
Used to restore the object after unserializing it from cache.
getPropInLang()  : string

Properties

$automatedFill

achd:automatedFill annotation property value

public bool $automatedFill = false

$comment

Associative array of rdfs:comment values (langauge as a key)

public array<string|int, string> $comment = []

$defaultValue

acdh:defaultValue annotation property value

public string|null $defaultValue = null

$domain

Property domain URI

public array<string|int, string> $domain = []

$exampleValue

acdh:exampleValue annotation property values

public array<string, string> $exampleValue = []

$id

Internal id of a corresponding repository resource

public int|null $id = null

$label

Associative array of label values (langauge as a key)

public array<string|int, string> $label = []

$langTag

is property range http://www.w3.org/1999/02/22-rdf-syntax-ns#langString

public bool $langTag

$ordering

achd:ordering annotation property value

public int $ordering = 99999

$properties

Property URIs of all properties this one inhertis from (includint itself)

public array<string|int, string> $properties = []

$property

Property URIs

public array<string|int, string> $property = []

$range

Property range URI

public array<string|int, string> $range = []

$recommendedClass

If a class is among acdh:recommendedClass for this property.

public bool $recommendedClass = []

After initialization the value is always a boolean one.

| array

$type

Property type URI (owl:DatatypeProperty or owl:ObjectProperty)

public string $type

$uri

The ontology entity URI within the ontology namespace

public string|null $uri = null

$vocabs

acdh:vocabs annotation property value

public string $vocabs = ''

$vocabularyValues

Array of vocabulary values fetched from vocabulary pointed by acdh:vocabs annotation property

private array<string|int, SkosConceptDesc> $vocabularyValues

It's initialized automatically upon the first read.

| null

Methods

__construct()

public __construct([object $d = null ][, array<string|int, string> $ids = [] ][, string|null $nmsp = null ][, string|null $skipNmsp = null ]) : mixed
Parameters
$d : object = null
$ids : array<string|int, string> = []
$nmsp : string|null = null
$skipNmsp : string|null = null

__get()

public __get(string $name) : mixed
Parameters
$name : string

__sleep()

public __sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkVocabularyValue()

Checks if a given value exists in a given vocabulary.

public checkVocabularyValue(string $value[, int $searchIn = Ontology::VOCABSVALUE_ID ]) : string|bool
Parameters
$value : string
$searchIn : int = Ontology::VOCABSVALUE_ID

combination of Ontology::VOCABSVALUE_* flags indicating where to search for the $value (in a concept URI/ID, skos:notation, skos:prefLabel, etc.)

Return values
string|bool —

a vocabulary value identifier, false if $value is invalid or true when property doesn't use a controlled vocabulary

getComment()

public getComment(string $lang[, string $fallbackLang = 'en' ]) : string
Parameters
$lang : string
$fallbackLang : string = 'en'
Return values
string

getLabel()

public getLabel(string $lang[, string $fallbackLang = 'en' ]) : string
Parameters
$lang : string
$fallbackLang : string = 'en'
Return values
string

getVocabularyValue()

Fetches SkosConceptDesc object desribing a vocabulary value.

public getVocabularyValue(string $value[, int $searchIn = Ontology::VOCABSVALUE_ID ]) : SkosConceptDesc|null
Parameters
$value : string
$searchIn : int = Ontology::VOCABSVALUE_ID

combination of Ontology::VOCABSVALUE_* flags indicating where to search for the $value (in a concept URI/ID, skos:notation, skos:prefLabel, etc.)

Return values
SkosConceptDesc|null

getVocabularyValues()

Returns a list of vocabulary values sorted according to the label property value in a given language.

public getVocabularyValues([string $lang = 'en' ]) : array<string|int, SkosConceptDesc>
Parameters
$lang : string = 'en'
Return values
array<string|int, SkosConceptDesc>

setOntologyObject()

Used to restore the object after unserializing it from cache.

public setOntologyObject(Ontology $ontology) : void
Parameters
$ontology : Ontology

getPropInLang()

private getPropInLang(string $property, string $lang, string $fallbackLang) : string
Parameters
$property : string
$lang : string
$fallbackLang : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results