ListTag Class Reference

Public Member Functions
	__construct ($name="", $value=[])
&	getValue ()
	getCount ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	count ($mode=COUNT_NORMAL)
	getType ()
	setTagType ($type)
	getTagType ()
	read (NBT $nbt, bool $network=false)
	__toString ()
Public Member Functions inherited from NamedTag
	__construct ($name="", $value=null)
	getName ()
	setName ($name)
Public Member Functions inherited from Tag
&	getValue ()
	getType ()
	setValue ($value)
	write (NBT $nbt, bool $network=false)
	read (NBT $nbt, bool $network=false)
	__toString ()

Additional Inherited Members
Protected Attributes inherited from NamedTag
	$__name
Protected Attributes inherited from Tag
	$value

Constructor & Destructor Documentation

__construct()

__construct	(		$name = "",
			$value = []
	)

ListTag constructor.

Parameters

string	$name
array	$value

                                                        {
        $this->__name = $name;
        foreach($value as $k => $v){
            $this->{$k} = $v;
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        $str = get_class($this) . "{\n";
        foreach($this as $tag){
            if($tag instanceof Tag){
                $str .= get_class($tag) . ":" . $tag->__toString() . "\n";
            }
        }
        return $str . "}";
    }

count()

count

(

$mode = COUNT_NORMAL

)

Parameters

int

$mode

Returns

int

                                               {
        for($i = 0; true; $i++){
            if(!isset($this->{$i})){
                return $i;
            }
            if($mode === COUNT_RECURSIVE){
                if($this->{$i} instanceof \Countable){
                    $i += count($this->{$i});
                }
            }
        }

        return $i;
    }

getCount()

getCount

(

)

Returns

int

                              {
        $count = 0;
        foreach($this as $tag){
            if($tag instanceof Tag){
                ++$count;
            }
        }

        return $count;
    }

getTagType()

getTagType

(

)

Returns

mixed

                                {
        return $this->tagType;
    }

getType()

getType

(

)

Returns

int

                             {
        return NBT::TAG_List;
    }

getValue()

& getValue

(

)

Returns

array

                               {
        $value = [];
        foreach($this as $k => $v){
            if($v instanceof Tag){
                $value[$k] = $v;
            }
        }

        return $value;
    }

offsetExists()

offsetExists

(

$offset

)

Parameters

mixed

$offset

Returns

bool

                                         {
        return isset($this->{$offset});
    }

offsetGet()

offsetGet

(

$offset

)

Parameters

mixed

$offset

Returns

null

                                      {
        if(isset($this->{$offset}) and $this->{$offset} instanceof Tag){
            if($this->{$offset} instanceof \ArrayAccess){
                return $this->{$offset};
            }else{
                return $this->{$offset}->getValue();
            }
        }

        return null;
    }

offsetSet()

offsetSet	(		$offset,
			$value
	)

Parameters

mixed	$offset
mixed	$value

                                              {
        if($value instanceof Tag){
            $this->{$offset} = $value;
        }elseif($this->{$offset} instanceof Tag){
            $this->{$offset}->setValue($value);
        }
    }

offsetUnset()

offsetUnset

(

$offset

)

Parameters

mixed

$offset

                                        {
        unset($this->{$offset});
    }

read()

read	(	NBT	$nbt,
		bool	$network = false
	)

Parameters

NBT	$nbt
bool	$network

Returns

mixed|void

                                                         {
        $this->value = [];
        $this->tagType = $nbt->getByte();
        $size = $nbt->getInt($network);
        for($i = 0; $i < $size and !$nbt->feof(); ++$i){
            switch($this->tagType){
                case NBT::TAG_Byte:
                    $tag = new ByteTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Short:
                    $tag = new ShortTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Int:
                    $tag = new IntTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Long:
                    $tag = new LongTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Float:
                    $tag = new FloatTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Double:
                    $tag = new DoubleTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_ByteArray:
                    $tag = new ByteArrayTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_String:
                    $tag = new StringTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_List:
                    $tag = new TagEnum("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_Compound:
                    $tag = new CompoundTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
                case NBT::TAG_IntArray:
                    $tag = new IntArrayTag("");
                    $tag->read($nbt, $network);
                    $this->{$i} = $tag;
                    break;
            }
        }
    }

setTagType()

setTagType

(

$type

)

Parameters

$type

                                     {
        $this->tagType = $type;
    }

---

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

• src/pocketmine/nbt/tag/ListTag.php