X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Ftry_get_value.rb;h=26c0b2d7784847c3c34572b2efae5a908d00164c;hp=34f94762e218a379422b425135119c56fc09e870;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/try_get_value.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/try_get_value.rb index 34f94762e..26c0b2d77 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/try_get_value.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/try_get_value.rb @@ -7,14 +7,16 @@ module Puppet::Parser::Functions :type => :rvalue, :arity => -2, :doc => <<-DOC - DEPRECATED: this function is deprecated, please use dig() instead. + @summary + **DEPRECATED:** this function is deprecated, please use dig() instead. - Looks up into a complex structure of arrays and hashes and returns a value - or the default value if nothing was found. + @return + Looks up into a complex structure of arrays and hashes and returns a value + or the default value if nothing was found. Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. - + `` $data = { 'a' => { 'b' => [ @@ -27,13 +29,15 @@ module Puppet::Parser::Functions $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' - + ``` + ``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. + ``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is