DOKK / manpages / debian 12 / libconfig-model-perl / Config::Model::BackendTrackOrder.3pm.en
Config::Model::BackendTrackOrder(3pm) User Contributed Perl Documentation Config::Model::BackendTrackOrder(3pm)

Config::Model::BackendTrackOrder - Track read order of elements from configuration

version 2.152

 # 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
 }

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.

THe constructor accepts the following parameters:

The backend object holding this tracker (required).
The node holding the backend above

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.

Returns a list of elements respecting user's order.

Returns the canonical list if Instance canonical attribute is 1.

Dominique Dumont

This software is Copyright (c) 2005-2022 by Dominique Dumont.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999
2022-07-28 perl v5.34.0