MetadataStore Class Reference

Public Member Functions
	setMetadata ($subject, $metadataKey, MetadataValue $newMetadataValue)
	getMetadata ($subject, $metadataKey)
	hasMetadata ($subject, $metadataKey)
	removeMetadata ($subject, $metadataKey, Plugin $owningPlugin)
	disambiguate (Metadatable $subject, $metadataKey)

Member Function Documentation

disambiguate()

disambiguate ( Metadatable  $subject,   $metadataKey  )

abstract

Creates a unique name for the object receiving metadata by combining unique data from the subject with a metadataKey.

Parameters

Metadatable	$subject
string	$metadataKey

Returns

string

Exceptions

getMetadata()

getMetadata	(		$subject,
			$metadataKey
	)

Returns all metadata values attached to an object. If multiple have attached metadata, each will value will be included.

Parameters

mixed	$subject
string	$metadataKey

Returns

MetadataValue[]

Exceptions

                                                       {
        $key = $this->disambiguate($subject, $metadataKey);
        if(isset($this->metadataMap[$key])){
            return $this->metadataMap[$key];
        }else{
            return [];
        }
    }

hasMetadata()

hasMetadata	(		$subject,
			$metadataKey
	)

Tests to see if a metadata attribute has been set on an object.

Parameters

mixed	$subject
string	$metadataKey

Returns

bool

Exceptions

                                                       {
        return isset($this->metadataMap[$this->disambiguate($subject, $metadataKey)]);
    }

removeMetadata()

removeMetadata	(		$subject,
			$metadataKey,
		Plugin	$owningPlugin
	)

Removes a metadata item owned by a plugin from a subject.

Parameters

mixed	$subject
string	$metadataKey
Plugin	$owningPlugin

Exceptions

                                                                                {
        $key = $this->disambiguate($subject, $metadataKey);
        if(isset($this->metadataMap[$key])){
            unset($this->metadataMap[$key][$owningPlugin]);
            if($this->metadataMap[$key]->count() === 0){
                unset($this->metadataMap[$key]);
            }
        }
    }

setMetadata()

setMetadata	(		$subject,
			$metadataKey,
		MetadataValue	$newMetadataValue
	)

Adds a metadata value to an object.

Parameters

mixed	$subject
string	$metadataKey
MetadataValue	$newMetadataValue

Exceptions

                                                                                        {
        $owningPlugin = $newMetadataValue->getOwningPlugin();
        if($owningPlugin === null){
            throw new PluginException("Plugin cannot be null");
        }

        $key = $this->disambiguate($subject, $metadataKey);
        if(!isset($this->metadataMap[$key])){
            //$entry = new \WeakMap();
            $this->metadataMap[$key] = new \SplObjectStorage();//$entry;
        }else{
            $entry = $this->metadataMap[$key];
        }
        $entry[$owningPlugin] = $newMetadataValue;
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/metadata/MetadataStore.php