Wikibase
MediaWiki Wikibase extension
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Wikibase\DataModel\Term\Fingerprint Class Reference

A container for all labels, all descriptions and all aliases (in all languages) of entities that support all three term types. More...

+ Inheritance diagram for Wikibase\DataModel\Term\Fingerprint:
+ Collaboration diagram for Wikibase\DataModel\Term\Fingerprint:

Public Member Functions

 __construct (TermList $labels=null, TermList $descriptions=null, AliasGroupList $aliasGroups=null)
 
 getLabels ()
 
 hasLabel ( $languageCode)
 
 getLabel ( $languageCode)
 
 setLabel ( $languageCode, $labelText)
 
 removeLabel ( $languageCode)
 
 getDescriptions ()
 
 hasDescription ( $languageCode)
 
 getDescription ( $languageCode)
 
 setDescription ( $languageCode, $descriptionText)
 
 removeDescription ( $languageCode)
 
 getAliasGroups ()
 
 hasAliasGroup ( $languageCode)
 
 getAliasGroup ( $languageCode)
 
 setAliasGroup ( $languageCode, array $aliases)
 
 removeAliasGroup ( $languageCode)
 
 equals ( $target)
 
 isEmpty ()
 
 setLabels (TermList $labels)
 
 setDescriptions (TermList $descriptions)
 
 setAliasGroups (AliasGroupList $groups)
 
 __clone ()
 

Static Public Member Functions

static newEmpty ()
 

Private Attributes

 $labels
 
 $descriptions
 
 $aliasGroups
 

Detailed Description

A container for all labels, all descriptions and all aliases (in all languages) of entities that support all three term types.

Should not be used for entity types that only support one or two of these term types.

Since
0.7.3
Copyright
GPL-2.0-or-later
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >
Thiemo Kreuz

Constructor & Destructor Documentation

◆ __construct()

Wikibase\DataModel\Term\Fingerprint::__construct ( TermList  $labels = null,
TermList  $descriptions = null,
AliasGroupList  $aliasGroups = null 
)
Parameters
TermList | null$labels
TermList | null$descriptions
AliasGroupList | null$aliasGroups

Member Function Documentation

◆ __clone()

Wikibase\DataModel\Term\Fingerprint::__clone ( )
See also
http://php.net/manual/en/language.oop5.cloning.php
Since
5.1

◆ equals()

Wikibase\DataModel\Term\Fingerprint::equals (   $target)
Since
0.7.4
Parameters
mixed$target
Returns
bool

◆ getAliasGroup()

Wikibase\DataModel\Term\Fingerprint::getAliasGroup (   $languageCode)
Since
0.7.4
Parameters
string$languageCode
Returns
AliasGroup
Exceptions
OutOfBoundsException
InvalidArgumentException

◆ getAliasGroups()

Wikibase\DataModel\Term\Fingerprint::getAliasGroups ( )
Since
0.7.4
Returns
AliasGroupList

Implements Wikibase\DataModel\Term\AliasesProvider.

◆ getDescription()

Wikibase\DataModel\Term\Fingerprint::getDescription (   $languageCode)
Since
0.7.4
Parameters
string$languageCode
Returns
Term
Exceptions
OutOfBoundsException
InvalidArgumentException

◆ getDescriptions()

Wikibase\DataModel\Term\Fingerprint::getDescriptions ( )
Since
0.7.3
Returns
TermList

Implements Wikibase\DataModel\Term\DescriptionsProvider.

◆ getLabel()

Wikibase\DataModel\Term\Fingerprint::getLabel (   $languageCode)
Since
0.7.4
Parameters
string$languageCode
Returns
Term
Exceptions
OutOfBoundsException
InvalidArgumentException

◆ getLabels()

Wikibase\DataModel\Term\Fingerprint::getLabels ( )
Since
0.7.3
Returns
TermList

Implements Wikibase\DataModel\Term\LabelsProvider.

◆ hasAliasGroup()

Wikibase\DataModel\Term\Fingerprint::hasAliasGroup (   $languageCode)
Since
0.9
Parameters
string$languageCode
Returns
boolean

◆ hasDescription()

Wikibase\DataModel\Term\Fingerprint::hasDescription (   $languageCode)
Since
0.9
Parameters
string$languageCode
Returns
boolean

◆ hasLabel()

Wikibase\DataModel\Term\Fingerprint::hasLabel (   $languageCode)
Since
0.9
Parameters
string$languageCode
Returns
boolean

◆ isEmpty()

Wikibase\DataModel\Term\Fingerprint::isEmpty ( )
Since
0.7.4
Returns
bool

◆ newEmpty()

static Wikibase\DataModel\Term\Fingerprint::newEmpty ( )
static
Deprecated:
since 2.5, use new Fingerprint() instead.
Returns
self

◆ removeAliasGroup()

Wikibase\DataModel\Term\Fingerprint::removeAliasGroup (   $languageCode)
Since
0.7.4
Parameters
string$languageCode

◆ removeDescription()

Wikibase\DataModel\Term\Fingerprint::removeDescription (   $languageCode)
Since
0.7.4
Parameters
string$languageCode

◆ removeLabel()

Wikibase\DataModel\Term\Fingerprint::removeLabel (   $languageCode)
Since
0.7.4
Parameters
string$languageCode

◆ setAliasGroup()

Wikibase\DataModel\Term\Fingerprint::setAliasGroup (   $languageCode,
array  $aliases 
)
Since
1.0
Parameters
string$languageCode
string[]$aliases
Exceptions
InvalidArgumentException

◆ setAliasGroups()

Wikibase\DataModel\Term\Fingerprint::setAliasGroups ( AliasGroupList  $groups)
Since
0.7.4
Parameters
AliasGroupList$groups

◆ setDescription()

Wikibase\DataModel\Term\Fingerprint::setDescription (   $languageCode,
  $descriptionText 
)
Since
1.0
Parameters
string$languageCode
string$descriptionText
Exceptions
InvalidArgumentException

◆ setDescriptions()

Wikibase\DataModel\Term\Fingerprint::setDescriptions ( TermList  $descriptions)
Since
0.7.4
Parameters
TermList$descriptions

◆ setLabel()

Wikibase\DataModel\Term\Fingerprint::setLabel (   $languageCode,
  $labelText 
)
Since
1.0
Parameters
string$languageCode
string$labelText
Exceptions
InvalidArgumentException

◆ setLabels()

Wikibase\DataModel\Term\Fingerprint::setLabels ( TermList  $labels)
Since
0.7.4
Parameters
TermList$labels

Member Data Documentation

◆ $aliasGroups

Wikibase\DataModel\Term\Fingerprint::$aliasGroups
private

◆ $descriptions

Wikibase\DataModel\Term\Fingerprint::$descriptions
private

◆ $labels

Wikibase\DataModel\Term\Fingerprint::$labels
private
The documentation for this class was generated from the following file: