NAME

OpenXPKI::Server::Workflow::WFObject::WFArray

DESCRIPTION

WFArray is used to manage an array data structure that is stored in a workflow context parameter. It inherits from WFObject.

The two primitive methods--count and value--provide the basis for all other methods in its interface.

See OpenXPKI::Server::Workflow::WFObject for details on the default accessors and additional properties.

SYNOPSIS

  my $queue = OpenXPKI::Server::Workflow::WFObject::WFArray->new(
    { workflow => $workflow,
    context_key => 'my_queue' } );

  print "my queue contains ", $queue->count, " element(s).\n";

METHODS

count

Returns the number of elements stored in the array. If the array is not initialized, 0 is returned.

value INDEX

Returns the element stored at the given INDEX.

If INDEX is not specified or undefined the method returns the complete array as a reference.

values

Returns a reference to a copy of the array stored in the instance.

pop, shift

Removes an element from the array, returning its value to the caller. For pop, the element from the end of the array is removed and for shift, the element from the beginning is removed.