NAME

Hash::Layout::Level - Level definition object for Hash::Layout

DESCRIPTION

This class is used internally by Hash::Layout and is not meant to be called directly. The list of hashrefs supplied to the levels param in the Hash::Layout constructor are each used as the constructor arguments passed to this class which create separate Hash::Layout::Level objects for each level.

Please refer to the main Hash::Layout documentation for more info.

ATTRIBUTES

index

The index value of the level (first level is at index 0). This is automatically supplied internally by Hash::Layout.

name

An optional name/string value for this level. This is purely informational and is not currently being used for anything.

delimiter

The character (or string) that is used by Hash::Layout when resolving composite key strings in to fully qualified key paths and identifying which part of the composite key should map to this level.

Defaults to a single forward-slash (/).

registered_keys

An optional list (ArrayRef coerced into HashRef) of keys that are associated specifically with this level. Like delimiter, this meta-data is used by Hash::Layout purely for mapping the sub-strings of a composite key to a specific level.

See the implementation of filter() in DBIx::Class::Schema::Diff for the best example of how registered_keys can be used.

SEE ALSO

• Hash::Layout

AUTHOR

Henry Van Styn <vanstyn@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by IntelliTree Solutions llc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.