Documentation · ViewHelper reference

XSD schema file | vhs master

Math / AverageViewHelper

Math: Average

Performs average across an array. If $a is an array and $b is an array, each member of $a is averaged against the same member in $b. If $a is an array and $b is a number, each member of $a is averaged agained $b. If $a is an array this array is averaged to one number. If $a is a number and $b is not provided or NULL, $a is gracefully returned as an average value of itself. /

  • Tag usage example

    <v:math.average a="[mixed]" fail="1" b="[mixed]">
    	<!-- tag content - may be ignored! -->
    </v:math.average>
  • Inline usage example

    {v:math.average(a: [mixed], fail: 1, b: [mixed])}

Arguments

Argument Description Type
a

First number for calculation

mixed
b

Optional: Second number or Iterator/Traversable/Array for calculation

mixed
fail

If TRUE, throws an Exception if argument "a" is not specified and no child content or inline argument is found. Usually okay to use a NULL value (as integer zero).

boolean
Required attribute

Revision history

commit fabf932edcba315f02429cb0ae8228163b4df316
Author: Claus Due <*****@wildside.dk>
Date:   Tue Nov 20 21:01:41 2012 +0100

    [FEATURE] Math / Average ViewHelper

commit 285ee9ab0ceb4a4eee28f07211d92b9f6958c65d
Author: Claus Due <*****@wildside.dk>
Date:   Tue Nov 20 21:18:32 2012 +0100

    [DOC] Adjust class doc comment sub package annotation, Math ViewHelpers

commit da31bad1d9bb058c072ddb5591e8ed907a1ae8e1
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 31 23:08:37 2013 +0100

    [TASK] Happy new year!

commit 52bd6e41ccfef3d8193b350153912a9716e6a087
Author: Benjamin Rau <*****@codearts.at>
Date:   Tue Apr 1 21:09:00 2014 +0200

    [TASK] CGL compliance

commit da7677bc74f14e9a9300e4ba4487e52c3cb97642
Author: Claus Due <*****@namelesscoder.net>
Date:   Sun Apr 20 01:13:33 2014 +0200

    [TASK] Switch to namespaces

commit 8bb2fc5ee124ba19b0a0ab8e061c9a153fc4651f
Author: Xaver Maierhofer <*****@xwissen.info>
Date:   Sun Jan 18 17:56:13 2015 +0100

    [TASK] Reference Copyright to license.md file