get_type¶

Returns "hash".

fetch_size¶

Returns the number of elements of the hash.

sort¶

Sort an ordered hash. Throws an error if called on a non ordered hash.

insort¶

Parameters: key

Create a new element in the ordered hash while keeping alphabetical order of the keys

Returns the newly created element.

Throws an error if called on a non ordered hash.

firstkey¶

Returns the first key of the hash. Behaves like "each" core perl function.

nextkey¶

Returns the next key of the hash. Behaves like "each" core perl function.

swap¶

Parameters: "( key1 , key2 )"

Swap the order of the 2 keys. Ignored for non ordered hash.

move¶

Parameters: "( key1 , key2 )"

Rename key1 in key2.

Also also optional check parameter to disable warning:

 move ('foo','bar', check => 'no')

move_after¶

Parameters: "( key_to_move [ , after_this_key ] )"

Move the first key after the second one. If the second parameter is omitted, the first key is placed in first position. Ignored for non ordered hash.

move_up¶

Parameters: "( key )"

Move the key up in a ordered hash. Attempt to move up the first key of an ordered hash is ignored. Ignored for non ordered hash.

move_down¶

Parameters: "( key )"

Move the key down in a ordered hash. Attempt to move up the last key of an ordered hash is ignored. Ignored for non ordered hash.

load_data¶

Parameters: "( data => ( hash_ref | array_ref ) [ , check => ... , ... ])"

Load data as a hash ref for standard hash.

Ordered hash should be loaded with an array ref or with a hash containing a special "__order" element. E.g. loaded with either:

  [ a => 'foo', b => 'bar' ]

or

  { __order => ['a','b'], b => 'bar', a => 'foo' }

"__skip_order" parameter can be used if loading order is not important:

  { __skip_order => 1, b => 'bar', a => 'foo'}

load_data can also be called with a single ref parameter.

get_info¶

Returns a list of information related to the hash. See "get_info" in Config::Model::Value for more details.