TranslationContainer Class Reference

Public Member Functions
	__construct ($text, array $params=[])
	getParameters ()
	getParameter ($i)
	setParameter ($i, $str)
	setParameters (array $params)
Public Member Functions inherited from TextContainer
	__construct ($text)
	setText ($text)
	getText ()
	__toString ()

Protected Attributes
	$params = []
Protected Attributes inherited from TextContainer
	$text

Constructor & Destructor Documentation

__construct()

__construct	(		$text,
		array	$params = []
	)

Parameters

string	$text
	string[]	$params

                                                          {
        parent::__construct($text);

        $this->setParameters($params);
    }

Member Function Documentation

getParameter()

getParameter

(

$i

)

Parameters

int

$i

Returns

string

                                    {
        return isset($this->params[$i]) ? $this->params[$i] : null;
    }

getParameters()

getParameters

(

)

Returns

string[]

                                   {
        return $this->params;
    }

setParameter()

setParameter	(		$i,
			$str
	)

Parameters

int	$i
string	$str

                                          {
        if($i < 0 or $i > count($this->params)){ //Intended, allow to set the last
            throw new \InvalidArgumentException("Invalid index $i, have " . count($this->params));
        }

        $this->params[(int) $i] = $str;
    }

setParameters()

setParameters

(

array

$params

)

Parameters

string[]

$params

                                                {
        $i = 0;
        foreach($params as $str){
            $this->params[$i] = (string) $str;

            ++$i;
        }
    }

Field Documentation

$params

$params = []

protected

---

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

• src/pocketmine/event/TranslationContainer.php