UpdateResult extends Result
Table of Contents
Methods
- __clone() : mixed
- __construct() : mixed
- __destruct() : mixed
- addError() : $this
- Adds the error.
- addErrors() : $this
- Adds array of Error objects
- getAffectedRowsCount() : int
- 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, mixed>
- Returns array of strings with error messages
- getErrors() : array<string|int, EntityError>|array<string|int, FieldError>
- Returns an array of Error objects
- getId() : array<string|int, mixed>|int|string
- Returns id of updated record
- getObject() : EntityObject
- getPrimary() : array<string|int, mixed>
- isSuccess() : bool
- Returns result status Within the core and events should be called with internalCall flag
- setAffectedRowsCount() : mixed
- setData() : $this
- Sets data of the result.
- setObject() : mixed
- setPrimary() : mixed
Methods
__clone()
public
__clone() : mixed
__construct()
public
__construct() : mixed
__destruct()
public
__destruct() : mixed
addError()
Adds the error.
public
addError(Error $error) : $this
Parameters
- $error : Error
Return values
$thisaddErrors()
Adds array of Error objects
public
addErrors(array<string|int, Error> $errors) : $this
Parameters
- $errors : array<string|int, Error>
Return values
$thisgetAffectedRowsCount()
public
getAffectedRowsCount() : int
Return values
intgetData()
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|nullgetErrorCollection()
Returns the error collection.
public
getErrorCollection() : ErrorCollection
Return values
ErrorCollectiongetErrorMessages()
Returns array of strings with error messages
public
getErrorMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>getErrors()
Returns an array of Error objects
public
getErrors() : array<string|int, EntityError>|array<string|int, FieldError>
Return values
array<string|int, EntityError>|array<string|int, FieldError>getId()
Returns id of updated record
public
getId() : array<string|int, mixed>|int|string
Return values
array<string|int, mixed>|int|stringgetObject()
public
getObject() : EntityObject
Return values
EntityObjectgetPrimary()
public
getPrimary() : array<string|int, mixed>
Return values
array<string|int, mixed>isSuccess()
Returns result status Within the core and events should be called with internalCall flag
public
isSuccess([bool $internalCall = false ]) : bool
Parameters
- $internalCall : bool = false
Return values
boolsetAffectedRowsCount()
public
setAffectedRowsCount(Connection $connection) : mixed
Parameters
- $connection : Connection
setData()
Sets data of the result.
public
setData(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Return values
$thissetObject()
public
setObject(EntityObject $object) : mixed
Parameters
- $object : EntityObject
setPrimary()
public
setPrimary(mixed $primary) : mixed
Parameters
- $primary : mixed