Config...:ListId(3pm)

📦
version 2.166 · 8 versions
, in ubuntu stonking

💖 Config::ListId — the list-element glow-up for your config model 💖

okay bestie, so this is a Perl manual page, section 3pm, and it's literally all about Config::ListId — the class that handles list elements for a Config::Model config. Buckle up, it's cute and it's useful. 🎀

✨ NAME ✨

Config::Model::ListId — handles the list element for a configuration model. that's it, that's the whole job 💅

🌸 VERSION 🌸

version 2.166 — periodt, that's the one we're working with.

🦋 SYNOPSIS 🦋

okay so like, don't come here looking for the whole rundown, because the actual synopsis lives elsewhere:

See "SYNOPSIS" in Config::Model::AnyId

go read that one, bestie, it's the main character of the synopsis situation 👑

💜 DESCRIPTION 💜

This class provides list elements for a Config::Model::Node. That's the vibe. It's the thing that makes listy config values behave. Slay. ✨

🌈 CONSTRUCTOR 🌈

do NOT create a ListId object yourself. literally just don't. it should never be created directly, no cap. 🙈

🍓 List model declaration 🍓

for how you actually declare this in a model, head over to the model declaration section of Config::Model::AnyId. that's where the tea is ☕

🌟 Methods 🌟

💅 get_type

Returns "list". iconic. short. perfect.

💅 fetch_size

Returns the number of elements of the list. it's giving "how many things are in here" energy 🔢

💅 load

Parameters: (string, [ check => 'no' ] )

Store a set of values passed as a comma separated list of values. Values can be quoted strings — like for real, i.e "a,a",b yields ('a,a', 'b').

"check" can be yes, no or skip. pick your fighter ✨

💅 store_set

Store a set of values (passed as list).

If tinkering with check is required, use the following way :

store_set ( \@v , check => 'skip' );

💅 move

Parameters: ( from_index, to_index, [ check => 'no' )

Move an element within the list. "check" can be 'yes', 'no', 'skip'. scoot over, bestie 🛼

💅 push

Parameters: ( value1, [ value2 ... ] )

push some values at the end of the list.

💅 push_x

Parameters: ( values => [ v1','v2', ...] , ... )

Like push with extended options. Options are:

  • check — Check value validaty. Either "yes" (default), "no", "skip"
  • values — Values to push (array_ref)
  • value — Single value to push
  • annotation — (no description given in the original, so like… it's there, and that's all we know 🫶)

💅 unshift

Parameters: ( value1, [ value2 ... ] )

unshift some values at the end of the list.

💅 insert_at

Parameters: ( idx, value1, [ value2 ... ] )

unshift some values at index idx in the list.

💅 insert_before

Parameters: ( ( val | qr/stuff/ ) , value1, [ value2 ... ] )

unshift some values before value equal to val or before value matching stuff.

💅 insort

Parameters: ( value1, [ value2 ... ] )

Insert zz value on xxx list so that existing alphanumeric order is preserved.

⚠️ insort yields unpexpected results when called on an unsorted list. bestie. do not. sorted lists only or chaos ensues 😭

💅 store

Equivalent to push_x. This method is provided to help write configuration parser, so the call is the same when dealing with leaf or list values. Prefer "push_x" when practical.

  • check — "yes", "no" or "skip"
  • annotation — list ref of annotation to store with the list values

Example:

$elt->push_x (
   values => [ 'v1','v2' ] ,
   annotation => [ 'v1 comment', 'v2 comment' ],
   check => 'skip'
);

💅 sort

Sort the content of the list. Can only be called on list of leaf. leaf lists only, bestie, don't try it anywhere else 🌿

💅 swap

Parameters: ( ida , idb )

Swap 2 elements within the array. tradesies 🔄

💅 remove

Parameters: ( idx )

Remove an element from the list. Equivalent to splice @list,$idx,1. bye bye element 👋

💅 load_data

Parameters: ( data => ( ref | scalar ) [, check => ... ] [ , split_reg => $re ] )

Clear and load list from data contained in the data array ref. If a scalar or a hash ref is passed, the list is cleared and the data is stored in the first element of the list. If split_reg is specified, the scalar is split to load the array.

For instance

$elt->load_data( data => 'foo,bar', split_reg => qr(,) ) ;

loads [ 'foo','bar'] in $elt. boom, loaded, slay 💥

💅 sort_algorithm

Returns a sub used to sort the list elements. See "sort" in perlfunc. Used only for list of leaves. This method can be overridden to alter sort order. custom sort vibes, if that's your thing 🎀

💅 get_info

Returns a list of information related to the list. See "get_info" in Config::Model::Value for more details. the info is over there, bestie 🔍

👑 AUTHOR 👑

Dominique Dumont, (ddumont at cpan dot org)

🌸 SEE ALSO 🌸

  • Config::Model::Model
  • Config::Model::Instance
  • Config::Model::AnyId
  • Config::Model::HashId
  • Config::Model::Value

go read those too, the whole squad is iconic 💖

👑 AUTHOR (again, yes, for real) 👑

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

and that's the whole page, bestie 🫶 written against perl v5.42.3, dated 2026-07-23, in section 3pm of the Perl docs. go forth and list responsibly 💅✨

📦 where this page comes from