Contentserv PHP API

CSObjectDatasourceMassActionResult
in package

Represents the result of mass action executed via object datasource.

Tags
since

CS24.0.0

Table of Contents

COUNT_UNAVAILABLE  = -1
Count definitions
create()  : CSObjectDatasourceMassActionResult
Creates a mass action result with the correspoding arguments.
getDataForKey()  : mixed
Returns the value for the key
setDataForKey()  : mixed
Sets the value for the key
toArray()  : array<string|int, mixed>
Transforms the mass action result into an array

Constants

Methods

create()

Creates a mass action result with the correspoding arguments.

public static create(int $iAffected, int $iTotalCount, array<string|int, mixed> $aParentIdsForReload) : CSObjectDatasourceMassActionResult
Parameters
$iAffected : int

Defines how many records got affected by the mass action

$iTotalCount : int

Defines how many records were subjected to the mass action

$aParentIdsForReload : array<string|int, mixed>

The list of parent ids to be reloaded in UI

Tags
access

public

Return values
CSObjectDatasourceMassActionResult —

The result of a mass action

getDataForKey()

Returns the value for the key

public getDataForKey(string $sKey) : mixed
Parameters
$sKey : string

The name of the key

Tags
Return values
mixed —

The value of the key. NULL if parameter was never assigned a value.

setDataForKey()

Sets the value for the key

public setDataForKey(string $sKey, mixed $mValue) : mixed
Parameters
$sKey : string

The name of the key

$mValue : mixed

The value of the key

Tags
Return values
mixed —

toArray()

Transforms the mass action result into an array

public toArray() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

The array representation of the mass action result


        

        
    




    

    

                

    

        

            
Search results