ApiOpenStudio PHPDoc

ConvertToTextTrait

Trait ConvertToTextTrait.

Trait to cast an input value to text.

Table of Contents

fromArrayToText()  : null
Convert array to text.
fromBooleanToText()  : string
Convert boolean to text.
fromFileToText()  : string
Convert file to text.
fromFloatToText()  : string
Convert float to text.
fromHtmlToText()  : string
Convert HTML to text.
fromImageToText()  : string
Convert image to text.
fromIntegerToText()  : string
Convert integer to text.
fromJsonToText()  : string
Convert JSON to text.
fromTextToText()  : string
Convert text to text.
fromUndefinedToText()  : null
Convert Undefined to text.
fromXmlToText()  : string
Convert XML to text.

Methods

fromArrayToText()

Convert array to text.

public fromArrayToText(array<string|int, mixed>|null $array) : null
Parameters
$array : array<string|int, mixed>|null
Tags
throws
ApiException
Return values
null

fromBooleanToText()

Convert boolean to text.

public fromBooleanToText(bool|null $boolean) : string
Parameters
$boolean : bool|null
Return values
string

fromFileToText()

Convert file to text.

public fromFileToText( $file) : string
Parameters
$file :
Return values
string

fromFloatToText()

Convert float to text.

public fromFloatToText(float|null $float) : string
Parameters
$float : float|null
Return values
string

fromHtmlToText()

Convert HTML to text.

public fromHtmlToText(string $html) : string
Parameters
$html : string
Return values
string

fromImageToText()

Convert image to text.

public fromImageToText( $image) : string
Parameters
$image :
Return values
string

fromIntegerToText()

Convert integer to text.

public fromIntegerToText(int|float|null $integer) : string
Parameters
$integer : int|float|null
Return values
string

fromJsonToText()

Convert JSON to text.

public fromJsonToText(string $json) : string
Parameters
$json : string
Return values
string

fromTextToText()

Convert text to text.

public fromTextToText(string $text) : string
Parameters
$text : string
Return values
string

fromUndefinedToText()

Convert Undefined to text.

public fromUndefinedToText( $data) : null
Parameters
$data :
Return values
null

fromXmlToText()

Convert XML to text.

public fromXmlToText(string $xml) : string
Parameters
$xml : string
Return values
string

Search results