Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::WorkUsernContributedrPerlrDocumentativity::Tools::WFArray(3)

Name
       OpenXPKI::Server::Workflow::Activity::Tools::WFArray

Description
       Allow array structures to be modelled in	the workflow action
       definitions using a single implementation class.

Examples
	 add_cert_to_publish:
	   class: OpenXPKI::Server::Workflow::Activity::Tools::WFArray
	     param:
	       array_name: cert_publish_queue
	       function: push
	       context_key: next_cert_to_publish

Parameters
       The following parameters	may be set in the definition of	the action:

   array_name
       The name	of the workflow	context	parameter containing the array to be
       used

   function
       The following functions are supported:

       push    Adds the	value of the context parameter named in	context_key to
	       the end of the array

       pusharray
	       Adds the	array contents contained in context parameter named in
	       context_key to the end of the array.

       pop     Removes the last	value from the end of the array	and assigns it
	       to the context parameter	named in context_key.

       unshift Adds the	value of the context parameter named in	context_key to
	       the beginning of	the array

       unshiftarray
	       Adds the	array contents contained in context parameter named in
	       context_key to the beginning of the array

       shift   Removes the last	value from the beginning of the	array and
	       assigns it to the context parameter named in context_key.

       value   Returns the value at the	position specified in array_index and
	       assigns it to the context parameter named in context_key.

	       If activity configuration explicitly sets index this value is
	       taken, otherwise	the index is taken from	the context value
	       contained in index_key.

       count   Returns the number of items in the array.

   context_key
       The name	of the context parameter that either contains or is the	lvalue
       for the function.

   index_key
       When retrieving an element of the array,	this specifies the name	of the
       context parameter that contains the index of the	element.

perl v5.24.1	       OpenXPKI::Server::Workflow::Activity::Tools::WFArray(3)

Name | Description | Examples | Parameters

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::Workflow::Activity::Tools::WFArray&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help