Bitrix API

ResultFile extends Result

Class Result

Table of Contents

Methods

__clone()  : mixed
__construct()  : mixed
ResultFile constructor.
addError()  : $this
Adds the error.
addErrors()  : $this
Adds array of Error objects
addMessage()  : mixed
addMessages()  : $this
Adds array of Message objects
addResult()  : mixed
addResults()  : mixed
getData()  : array<string|int, mixed>
Returns data array saved into the result.
getError()  : Error|null
Returns the Error object.
getErrorCollection()  : ErrorCollection
Returns the error collection.
getErrorMessages()  : array<string|int, string>
Returns array of strings with error messages
getErrors()  : array<string|int, Error>
Returns an array of Error objects.
getFileContent()  : string
getFileName()  : string
getMessages()  : array<string|int, Message>
getMessagesCollection()  : array<string|int, mixed>|MessagesCollection
getMessagesMessages()  : array<string|int, mixed>
getRequestResults()  : array<string|int, RequestResult>
getResults()  : array<string|int, mixed>
getShipmentResults()  : array<string|int, ShipmentResult>
isSuccess()  : bool
Returns the result status.
setData()  : $this
Sets data of the result.
setFileContent()  : mixed
setFileName()  : mixed
setResults()  : mixed

Methods

__clone()

public __clone() : mixed

__construct()

ResultFile constructor.

public __construct([string $fileName = '' ][, string $fileContent = '' ]) : mixed
Parameters
$fileName : string = ''
$fileContent : string = ''

addError()

Adds the error.

public addError(Error $error) : $this
Parameters
$error : Error
Return values
$this

addErrors()

Adds array of Error objects

public addErrors(array<string|int, Error$errors) : $this
Parameters
$errors : array<string|int, Error>
Return values
$this

addMessages()

Adds array of Message objects

public addMessages(array<string|int, Message$messages) : $this
Parameters
$messages : array<string|int, Message>
Return values
$this

addResults()

public addResults(array<string|int, Result$results) : mixed
Parameters
$results : array<string|int, Result>

getData()

Returns data array saved into the result.

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getError()

Returns the Error object.

public getError() : Error|null
Return values
Error|null

getErrorMessages()

Returns array of strings with error messages

public getErrorMessages() : array<string|int, string>
Return values
array<string|int, string>

getErrors()

Returns an array of Error objects.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFileContent()

public getFileContent() : string
Return values
string

getFileName()

public getFileName() : string
Return values
string

getMessages()

public getMessages() : array<string|int, Message>
Return values
array<string|int, Message>

getMessagesMessages()

public getMessagesMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResults()

public getResults() : array<string|int, mixed>
Return values
array<string|int, mixed>

isSuccess()

Returns the result status.

public isSuccess() : bool
Return values
bool

setData()

Sets data of the result.

public setData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>
Return values
$this

setFileContent()

public setFileContent(string $fileContent) : mixed
Parameters
$fileContent : string

setFileName()

public setFileName(string $fileName) : mixed
Parameters
$fileName : string

setResults()

public setResults(array<string|int, mixed> $results) : mixed
Parameters
$results : array<string|int, mixed>

        
On this page

Search results