Config::Model::BackendTrackOrder(3pm)

Config::Model::BackendTrackOrder3pm

Track read order of elements from configuration

Usage

 # inside a backend
 use Config::Model::BackendTrackOrder;
 has tracker => (
    is => 'ro',
    isa => 'Config::Model::BackendTrackOrder',
    lazy_build => 1,
 );
 sub _build_tracker {
    my $self = shift;
    return Config::Model::BackendTrackOrder->new(
        backend_obj => $self,
        node => $self->node,
    ) ;
 }
 # register elements to record user order
 $self->tracker->register_element('foo');
 $self->tracker->register_element('bar');
 # later, when writing data back
 foreach my $elt ( $self->tracker->get_ordered_element_names ) {
      # write data
 }

Version

version 2.155

Overview

This module is used by backends to record the order of the configuration elements found in user file. Later these elements can be written back in the file using the same order.

Data are written in canonical order if "canonical" method of the "Config::Model::Instance" in instance returns true.

Constructor

THe constructor accepts the following parameters:

backend_obj

The backend object holding this tracker (required).

node

The node holding the backend above

Methods

register_element

Register the element and keep track of the registration order during initial load

Element registered after initial load (i.e . user modification) are registered using canonical order.

get_ordered_element_names

Returns a list of elements respecting user's order.

Returns the canonical list if Instance canonical attribute is 1.

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

Author

Dominique Dumont

From libconfig-model-perl 2.155-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.