Zmienne kontekstowe umożliwiają tworzenie komponentów zbudowanych w sposób funkcyjny. Twórca komponentu może zdefiniować wiele dowolnych zmiennych kontekstowych, które będą mogły być następnie wykorzystane przez użytkownika w funkcjach zdefiniowanych jako parametry tego komponentu.

Przykładem takiego komponentu może być walidator, który pozwala na walidację danych w tabelce dynamicznej. Udostępniana jest wtedy zmienna kontekstowa $currentRow przechowująca indeks aktualnego wiersza w tabelce. Jedynym parametrem będzie funkcja, która zwróci wartość logiczną mówiącą czy dany wiersz jest poprawny czy nie.

Image Modified

Tak skonfigurowana akcja będzie oznaczała, że funkcja not(empty(item($currentRow, $Nazwa Dostawcy))) zostanie wywołana dla każdego wiersza ze zmieniającym się parametrem $currentRow:

• not(empty(item(0, $Nazwa Dostawcy)))
• not(empty(item(1, $Nazwa Dostawcy)))
• not(empty(item(2, $Nazwa Dostawcy)))

Pozwala to na tworzenie bardziej uniwersalnych komponentów. Nie musimy też tworzyć wielu przeciążeń funkcji np. dla parametrów tablicowych

Context variables allow the creation of components built in a functional way. The creator of a component can define many arbitrary context variables, which can then be used by the user in functions defined as parameters of that component.

An example of such a component could be a validator, which allows you to validate data in a dynamic table. A context variable $currentRow is then provided, storing the index of the current row in the table. The only parameter would be a function that would return a logical value saying whether the row is valid or not

Image Added

The action configured this way will mean that the not(empty(item($currentRow, $Nazwa Dostawcy))) function will be called for each row with a changing $currentRow parameter:

• not(empty(item(0, $Nazwa Dostawcy)))
• not(empty(item(1, $Nazwa Dostawcy)))
• not(empty(item(2, $Nazwa Dostawcy)))

This allows us to create more versatile components. Also, we don't need to create multiple function overloads, for example, for array parameters - it's enough to use a component that allows iteration over rows of such arrays.

Defining context variables

Defining context variables (

@Define
public void definition( ValidatorDefinitionBuilder builder )
{
    builder
        .id( "contextVariableExample" )
        .name( "Context Variable Example" )
        .category( Categories.TEST )
        .contextVariable()
            .id( "currentRow" )
            .name( "currentRow" )
            .description( "Current table row index" )
            .type( Types.INTEGER )
            .create()
        .parameter()
            .id( "fn" )
            .name( "Function" )
            .type( Types.FUNCTION )
            .create();
}

Determine the value of context variables

The value of context variables is set using an object 

parameter to the component method (e.g. validate for validator) 

and use the set(id, value) method:

public void validate( @Param FunctionCall fn, ContextVariables contextVariables, ValidationErrors errors )
{
    int length = ...; // liczba wierszy
    for ( int i = 0; i < length; i++ )
    {
        contextVariables.set( "currentRow", i );
        if ( !fn.<Boolean> call() )
        {
            errors.add( "Validation errror" );
        }
    }
}

Context variables in form actions

Due to the different environment of running form actions, the way of setting these variables is a little different. We set the value of context variables using the setContextVariable

 PW.FormActions.create('context-var-example', {
	defaultActions: {
		variableSet: function(vs, added, updated, removed) {
			this.invoke(vs);
		}
	},
	invoke: function(vs) {
		var fn = this.get('fn');
		var target = this.get('target');
 
		PW.each(vs.getRecords(), function(record, index) {
			this.setContextVariable("currentRow", index);


			var newValue = fn.call();
			target.setItemValue(newValue, index);
		}, this);
	}
});