/usr/share/perl5/DBIx/Class/Ordered.pm is in libdbix-class-perl 0.082821-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 | package DBIx::Class::Ordered;
use strict;
use warnings;
use base qw( DBIx::Class );
use List::Util 'first';
use namespace::clean;
=head1 NAME
DBIx::Class::Ordered - Modify the position of objects in an ordered list.
=head1 SYNOPSIS
Create a table for your ordered data.
CREATE TABLE items (
item_id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
position INTEGER NOT NULL
);
Optionally, add one or more columns to specify groupings, allowing you
to maintain independent ordered lists within one table:
CREATE TABLE items (
item_id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
position INTEGER NOT NULL,
group_id INTEGER NOT NULL
);
Or even
CREATE TABLE items (
item_id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
position INTEGER NOT NULL,
group_id INTEGER NOT NULL,
other_group_id INTEGER NOT NULL
);
In your Schema or DB class add "Ordered" to the top
of the component list.
__PACKAGE__->load_components(qw( Ordered ... ));
Specify the column that stores the position number for
each row.
package My::Item;
__PACKAGE__->position_column('position');
If you are using one grouping column, specify it as follows:
__PACKAGE__->grouping_column('group_id');
Or if you have multiple grouping columns:
__PACKAGE__->grouping_column(['group_id', 'other_group_id']);
That's it, now you can change the position of your objects.
#!/use/bin/perl
use My::Item;
my $item = My::Item->create({ name=>'Matt S. Trout' });
# If using grouping_column:
my $item = My::Item->create({ name=>'Matt S. Trout', group_id=>1 });
my $rs = $item->siblings();
my @siblings = $item->siblings();
my $sibling;
$sibling = $item->first_sibling();
$sibling = $item->last_sibling();
$sibling = $item->previous_sibling();
$sibling = $item->next_sibling();
$item->move_previous();
$item->move_next();
$item->move_first();
$item->move_last();
$item->move_to( $position );
$item->move_to_group( 'groupname' );
$item->move_to_group( 'groupname', $position );
$item->move_to_group( {group_id=>'groupname', 'other_group_id=>'othergroupname'} );
$item->move_to_group( {group_id=>'groupname', 'other_group_id=>'othergroupname'}, $position );
=head1 DESCRIPTION
This module provides a simple interface for modifying the ordered
position of DBIx::Class objects.
=head1 AUTO UPDATE
All of the move_* methods automatically update the rows involved in
the query. This is not configurable and is due to the fact that if you
move a record it always causes other records in the list to be updated.
=head1 METHODS
=head2 position_column
__PACKAGE__->position_column('position');
Sets and retrieves the name of the column that stores the
positional value of each record. Defaults to "position".
=cut
__PACKAGE__->mk_classdata( 'position_column' => 'position' );
=head2 grouping_column
__PACKAGE__->grouping_column('group_id');
This method specifies a column to limit all queries in
this module by. This effectively allows you to have multiple
ordered lists within the same table.
=cut
__PACKAGE__->mk_classdata( 'grouping_column' );
=head2 null_position_value
__PACKAGE__->null_position_value(undef);
This method specifies a value of L</position_column> which B<would
never be assigned to a row> during normal operation. When
a row is moved, its position is set to this value temporarily, so
that any unique constraints can not be violated. This value defaults
to 0, which should work for all cases except when your positions do
indeed start from 0.
=cut
__PACKAGE__->mk_classdata( 'null_position_value' => 0 );
=head2 siblings
my $rs = $item->siblings();
my @siblings = $item->siblings();
Returns an B<ordered> resultset of all other objects in the same
group excluding the one you called it on.
The ordering is a backwards-compatibility artifact - if you need
a resultset with no ordering applied use C<_siblings>
=cut
sub siblings {
my $self = shift;
return $self->_siblings->search ({}, { order_by => $self->position_column } );
}
=head2 previous_siblings
my $prev_rs = $item->previous_siblings();
my @prev_siblings = $item->previous_siblings();
Returns a resultset of all objects in the same group
positioned before the object on which this method was called.
=cut
sub previous_siblings {
my $self = shift;
my $position_column = $self->position_column;
my $position = $self->get_column ($position_column);
return ( defined $position
? $self->_siblings->search ({ $position_column => { '<', $position } })
: $self->_siblings
);
}
=head2 next_siblings
my $next_rs = $item->next_siblings();
my @next_siblings = $item->next_siblings();
Returns a resultset of all objects in the same group
positioned after the object on which this method was called.
=cut
sub next_siblings {
my $self = shift;
my $position_column = $self->position_column;
my $position = $self->get_column ($position_column);
return ( defined $position
? $self->_siblings->search ({ $position_column => { '>', $position } })
: $self->_siblings
);
}
=head2 previous_sibling
my $sibling = $item->previous_sibling();
Returns the sibling that resides one position back. Returns 0
if the current object is the first one.
=cut
sub previous_sibling {
my $self = shift;
my $position_column = $self->position_column;
my $psib = $self->previous_siblings->search(
{},
{ rows => 1, order_by => { '-desc' => $position_column } },
)->single;
return defined $psib ? $psib : 0;
}
=head2 first_sibling
my $sibling = $item->first_sibling();
Returns the first sibling object, or 0 if the first sibling
is this sibling.
=cut
sub first_sibling {
my $self = shift;
my $position_column = $self->position_column;
my $fsib = $self->previous_siblings->search(
{},
{ rows => 1, order_by => { '-asc' => $position_column } },
)->single;
return defined $fsib ? $fsib : 0;
}
=head2 next_sibling
my $sibling = $item->next_sibling();
Returns the sibling that resides one position forward. Returns 0
if the current object is the last one.
=cut
sub next_sibling {
my $self = shift;
my $position_column = $self->position_column;
my $nsib = $self->next_siblings->search(
{},
{ rows => 1, order_by => { '-asc' => $position_column } },
)->single;
return defined $nsib ? $nsib : 0;
}
=head2 last_sibling
my $sibling = $item->last_sibling();
Returns the last sibling, or 0 if the last sibling is this
sibling.
=cut
sub last_sibling {
my $self = shift;
my $position_column = $self->position_column;
my $lsib = $self->next_siblings->search(
{},
{ rows => 1, order_by => { '-desc' => $position_column } },
)->single;
return defined $lsib ? $lsib : 0;
}
# an optimized method to get the last sibling position value without inflating a result object
sub _last_sibling_posval {
my $self = shift;
my $position_column = $self->position_column;
my $cursor = $self->next_siblings->search(
{},
{ rows => 1, order_by => { '-desc' => $position_column }, select => $position_column },
)->cursor;
my ($pos) = $cursor->next;
return $pos;
}
=head2 move_previous
$item->move_previous();
Swaps position with the sibling in the position previous in
the list. Returns 1 on success, and 0 if the object is
already the first one.
=cut
sub move_previous {
my $self = shift;
return $self->move_to ($self->_position - 1);
}
=head2 move_next
$item->move_next();
Swaps position with the sibling in the next position in the
list. Returns 1 on success, and 0 if the object is already
the last in the list.
=cut
sub move_next {
my $self = shift;
return 0 unless defined $self->_last_sibling_posval; # quick way to check for no more siblings
return $self->move_to ($self->_position + 1);
}
=head2 move_first
$item->move_first();
Moves the object to the first position in the list. Returns 1
on success, and 0 if the object is already the first.
=cut
sub move_first {
return shift->move_to( 1 );
}
=head2 move_last
$item->move_last();
Moves the object to the last position in the list. Returns 1
on success, and 0 if the object is already the last one.
=cut
sub move_last {
my $self = shift;
my $last_posval = $self->_last_sibling_posval;
return 0 unless defined $last_posval;
return $self->move_to( $self->_position_from_value ($last_posval) );
}
=head2 move_to
$item->move_to( $position );
Moves the object to the specified position. Returns 1 on
success, and 0 if the object is already at the specified
position.
=cut
sub move_to {
my( $self, $to_position ) = @_;
return 0 if ( $to_position < 1 );
my $position_column = $self->position_column;
my $is_txn;
if ($is_txn = $self->result_source->schema->storage->transaction_depth) {
# Reload position state from storage
# The thinking here is that if we are in a transaction, it is
# *more likely* the object went out of sync due to resultset
# level shenanigans. Instead of always reloading (slow) - go
# ahead and hand-hold only in the case of higher layers
# requesting the safety of a txn
$self->store_column(
$position_column,
( $self->result_source
->resultset
->search($self->_storage_ident_condition, { rows => 1, columns => $position_column })
->cursor
->next
)[0] || $self->throw_exception(
sprintf "Unable to locate object '%s' in storage - object went ouf of sync...?",
$self->ID
),
);
delete $self->{_dirty_columns}{$position_column};
}
elsif ($self->is_column_changed ($position_column) ) {
# something changed our position, we need to know where we
# used to be - use the stashed value
$self->store_column($position_column, delete $self->{_column_data_in_storage}{$position_column});
delete $self->{_dirty_columns}{$position_column};
}
my $from_position = $self->_position;
if ( $from_position == $to_position ) { # FIXME this will not work for non-numeric order
return 0;
}
my $guard = $is_txn ? undef : $self->result_source->schema->txn_scope_guard;
my ($direction, @between);
if ( $from_position < $to_position ) {
$direction = -1;
@between = map { $self->_position_value ($_) } ( $from_position + 1, $to_position );
}
else {
$direction = 1;
@between = map { $self->_position_value ($_) } ( $to_position, $from_position - 1 );
}
my $new_pos_val = $self->_position_value ($to_position); # record this before the shift
# we need to null-position the moved row if the position column is part of a constraint
if (grep { $_ eq $position_column } ( map { @$_ } (values %{{ $self->result_source->unique_constraints }} ) ) ) {
$self->_ordered_internal_update({ $position_column => $self->null_position_value });
}
$self->_shift_siblings ($direction, @between);
$self->_ordered_internal_update({ $position_column => $new_pos_val });
$guard->commit if $guard;
return 1;
}
=head2 move_to_group
$item->move_to_group( $group, $position );
Moves the object to the specified position of the specified
group, or to the end of the group if $position is undef.
1 is returned on success, and 0 is returned if the object is
already at the specified position of the specified group.
$group may be specified as a single scalar if only one
grouping column is in use, or as a hashref of column => value pairs
if multiple grouping columns are in use.
=cut
sub move_to_group {
my( $self, $to_group, $to_position ) = @_;
# if we're given a single value, turn it into a hashref
unless (ref $to_group eq 'HASH') {
my @gcols = $self->_grouping_columns;
$self->throw_exception ('Single group supplied for a multi-column group identifier') if @gcols > 1;
$to_group = {$gcols[0] => $to_group};
}
my $position_column = $self->position_column;
return 0 if ( defined($to_position) and $to_position < 1 );
# check if someone changed the _grouping_columns - this will
# prevent _is_in_group working, so we need to restore the
# original stashed values
for ($self->_grouping_columns) {
if ($self->is_column_changed ($_)) {
$self->store_column($_, delete $self->{_column_data_in_storage}{$_});
delete $self->{_dirty_columns}{$_};
}
}
if ($self->_is_in_group ($to_group) ) {
my $ret;
if (defined $to_position) {
$ret = $self->move_to ($to_position);
}
return $ret||0;
}
my $guard = $self->result_source->schema->txn_scope_guard;
# Move to end of current group to adjust siblings
$self->move_last;
$self->set_inflated_columns({ %$to_group, $position_column => undef });
my $new_group_last_posval = $self->_last_sibling_posval;
my $new_group_last_position = $self->_position_from_value (
$new_group_last_posval
);
if ( not defined($to_position) or $to_position > $new_group_last_position) {
$self->set_column(
$position_column => $new_group_last_position
? $self->_next_position_value ( $new_group_last_posval )
: $self->_initial_position_value
);
}
else {
my $bumped_pos_val = $self->_position_value ($to_position);
my @between = map { $self->_position_value ($_) } ($to_position, $new_group_last_position);
$self->_shift_siblings (1, @between); #shift right
$self->set_column( $position_column => $bumped_pos_val );
}
$self->_ordered_internal_update;
$guard->commit;
return 1;
}
=head2 insert
Overrides the DBIC insert() method by providing a default
position number. The default will be the number of rows in
the table +1, thus positioning the new record at the last position.
=cut
sub insert {
my $self = shift;
my $position_column = $self->position_column;
unless ($self->get_column($position_column)) {
my $lsib_posval = $self->_last_sibling_posval;
$self->set_column(
$position_column => (defined $lsib_posval
? $self->_next_position_value ( $lsib_posval )
: $self->_initial_position_value
)
);
}
return $self->next::method( @_ );
}
=head2 update
Overrides the DBIC update() method by checking for a change
to the position and/or group columns. Movement within a
group or to another group is handled by repositioning
the appropriate siblings. Position defaults to the end
of a new group if it has been changed to undef.
=cut
sub update {
my $self = shift;
# this is set by _ordered_internal_update()
return $self->next::method(@_) if $self->result_source->schema->{_ORDERED_INTERNAL_UPDATE};
my $upd = shift;
$self->set_inflated_columns($upd) if $upd;
my $position_column = $self->position_column;
my @group_columns = $self->_grouping_columns;
# see if the order is already changed
my $changed_ordering_cols = { map { $_ => $self->get_column($_) } grep { $self->is_column_changed($_) } ($position_column, @group_columns) };
# nothing changed - short circuit
if (! keys %$changed_ordering_cols) {
return $self->next::method( undef, @_ );
}
elsif (defined first { exists $changed_ordering_cols->{$_} } @group_columns ) {
$self->move_to_group(
# since the columns are already re-set the _grouping_clause is correct
# move_to_group() knows how to get the original storage values
{ $self->_grouping_clause },
# The FIXME bit contradicts the documentation: POD states that
# when changing groups without supplying explicit positions in
# move_to_group(), we push the item to the end of the group.
# However when I was rewriting this, the position from the old
# group was clearly passed to the new one
# Probably needs to go away (by ribasushi)
(exists $changed_ordering_cols->{$position_column}
? $changed_ordering_cols->{$position_column} # means there was a position change supplied with the update too
: $self->_position # FIXME! (replace with undef)
),
);
}
else {
$self->move_to($changed_ordering_cols->{$position_column});
}
return $self;
}
=head2 delete
Overrides the DBIC delete() method by first moving the object
to the last position, then deleting it, thus ensuring the
integrity of the positions.
=cut
sub delete {
my $self = shift;
my $guard = $self->result_source->schema->txn_scope_guard;
$self->move_last;
$self->next::method( @_ );
$guard->commit;
return $self;
}
# add the current position/group to the things we track old values for
sub _track_storage_value {
my ($self, $col) = @_;
return $self->next::method($col) || defined first { $_ eq $col } ($self->position_column, $self->_grouping_columns);
}
=head1 METHODS FOR EXTENDING ORDERED
You would want to override the methods below if you use sparse
(non-linear) or non-numeric position values. This can be useful
if you are working with preexisting non-normalised position data,
or if you need to work with materialized path columns.
=head2 _position_from_value
my $num_pos = $item->_position_from_value ( $pos_value )
Returns the B<absolute numeric position> of an object with a B<position
value> set to C<$pos_value>. By default simply returns C<$pos_value>.
=cut
sub _position_from_value {
my ($self, $val) = @_;
return 0 unless defined $val;
# #the right way to do this
# return $self -> _group_rs
# -> search({ $self->position_column => { '<=', $val } })
# -> count
return $val;
}
=head2 _position_value
my $pos_value = $item->_position_value ( $pos )
Returns the B<value> of L</position_column> of the object at numeric
position C<$pos>. By default simply returns C<$pos>.
=cut
sub _position_value {
my ($self, $pos) = @_;
# #the right way to do this (not optimized)
# my $position_column = $self->position_column;
# return $self -> _group_rs
# -> search({}, { order_by => $position_column })
# -> slice ( $pos - 1)
# -> single
# -> get_column ($position_column);
return $pos;
}
=head2 _initial_position_value
__PACKAGE__->_initial_position_value(0);
This method specifies a B<value> of L</position_column> which is assigned
to the first inserted element of a group, if no value was supplied at
insertion time. All subsequent values are derived from this one by
L</_next_position_value> below. Defaults to 1.
=cut
__PACKAGE__->mk_classdata( '_initial_position_value' => 1 );
=head2 _next_position_value
my $new_value = $item->_next_position_value ( $position_value )
Returns a position B<value> that would be considered C<next> with
regards to C<$position_value>. Can be pretty much anything, given
that C<< $position_value < $new_value >> where C<< < >> is the
SQL comparison operator (usually works fine on strings). The
default method expects C<$position_value> to be numeric, and
returns C<$position_value + 1>
=cut
sub _next_position_value {
return $_[1] + 1;
}
=head2 _shift_siblings
$item->_shift_siblings ($direction, @between)
Shifts all siblings with B<positions values> in the range @between
(inclusive) by one position as specified by $direction (left if < 0,
right if > 0). By default simply increments/decrements each
L</position_column> value by 1, doing so in a way as to not violate
any existing constraints.
Note that if you override this method and have unique constraints
including the L</position_column> the shift is not a trivial task.
Refer to the implementation source of the default method for more
information.
=cut
sub _shift_siblings {
my ($self, $direction, @between) = @_;
return 0 unless $direction;
my $position_column = $self->position_column;
my ($op, $ord);
if ($direction < 0) {
$op = '-';
$ord = 'asc';
}
else {
$op = '+';
$ord = 'desc';
}
my $shift_rs = $self->_group_rs-> search ({ $position_column => { -between => \@between } });
# some databases (sqlite, pg, perhaps others) are dumb and can not do a
# blanket increment/decrement without violating a unique constraint.
# So what we do here is check if the position column is part of a unique
# constraint, and do a one-by-one update if this is the case.
my $rsrc = $self->result_source;
# set in case there are more cascades combined with $rs->update => $rs_update_all overrides
local $rsrc->schema->{_ORDERED_INTERNAL_UPDATE} = 1;
my @pcols = $rsrc->primary_columns;
if (
first { $_ eq $position_column } ( map { @$_ } (values %{{ $rsrc->unique_constraints }} ) )
) {
my $clean_rs = $rsrc->resultset;
for ( $shift_rs->search (
{}, { order_by => { "-$ord", $position_column }, select => [$position_column, @pcols] }
)->cursor->all ) {
my $pos = shift @$_;
$clean_rs->find(@$_)->update ({ $position_column => $pos + ( ($op eq '+') ? 1 : -1 ) });
}
}
else {
$shift_rs->update ({ $position_column => \ "$position_column $op 1" } );
}
}
# This method returns a resultset containing all members of the row
# group (including the row itself).
sub _group_rs {
my $self = shift;
return $self->result_source->resultset->search({$self->_grouping_clause()});
}
# Returns an unordered resultset of all objects in the same group
# excluding the object you called this method on.
sub _siblings {
my $self = shift;
my $position_column = $self->position_column;
my $pos;
return defined ($pos = $self->get_column($position_column))
? $self->_group_rs->search(
{ $position_column => { '!=' => $pos } },
)
: $self->_group_rs
;
}
# Returns the B<absolute numeric position> of the current object, with the
# first object being at position 1, its sibling at position 2 and so on.
sub _position {
my $self = shift;
return $self->_position_from_value ($self->get_column ($self->position_column) );
}
# This method returns one or more name=>value pairs for limiting a search
# by the grouping column(s). If the grouping column is not defined then
# this will return an empty list.
sub _grouping_clause {
my( $self ) = @_;
return map { $_ => $self->get_column($_) } $self->_grouping_columns();
}
# Returns a list of the column names used for grouping, regardless of whether
# they were specified as an arrayref or a single string, and returns ()
# if there is no grouping.
sub _grouping_columns {
my( $self ) = @_;
my $col = $self->grouping_column();
if (ref $col eq 'ARRAY') {
return @$col;
} elsif ($col) {
return ( $col );
} else {
return ();
}
}
# Returns true if the object is in the group represented by hashref $other
sub _is_in_group {
my ($self, $other) = @_;
my $current = {$self->_grouping_clause};
no warnings qw/uninitialized/;
return 0 if (
join ("\x00", sort keys %$current)
ne
join ("\x00", sort keys %$other)
);
for my $key (keys %$current) {
return 0 if $current->{$key} ne $other->{$key};
}
return 1;
}
# This is a short-circuited method, that is used internally by this
# module to update positioning values in isolation (i.e. without
# triggering any of the positioning integrity code).
#
# Some day you might get confronted by datasets that have ambiguous
# positioning data (e.g. duplicate position values within the same group,
# in a table without unique constraints). When manually fixing such data
# keep in mind that you can not invoke L<DBIx::Class::Row/update> like
# you normally would, as it will get confused by the wrong data before
# having a chance to update the ill-defined row. If you really know what
# you are doing use this method which bypasses any hooks introduced by
# this module.
sub _ordered_internal_update {
my $self = shift;
local $self->result_source->schema->{_ORDERED_INTERNAL_UPDATE} = 1;
return $self->update (@_);
}
1;
__END__
=head1 CAVEATS
=head2 Resultset Methods
Note that all Insert/Create/Delete overrides are happening on
L<DBIx::Class::Row> methods only. If you use the
L<DBIx::Class::ResultSet> versions of
L<update|DBIx::Class::ResultSet/update> or
L<delete|DBIx::Class::ResultSet/delete>, all logic present in this
module will be bypassed entirely (possibly resulting in a broken
order-tree). Instead always use the
L<update_all|DBIx::Class::ResultSet/update_all> and
L<delete_all|DBIx::Class::ResultSet/delete_all> methods, which will
invoke the corresponding L<row|DBIx::Class::Row> method on every
member of the given resultset.
=head2 Race Condition on Insert
If a position is not specified for an insert, a position
will be chosen based either on L</_initial_position_value> or
L</_next_position_value>, depending if there are already some
items in the current group. The space of time between the
necessary selects and insert introduces a race condition.
Having unique constraints on your position/group columns,
and using transactions (see L<DBIx::Class::Storage/txn_do>)
will prevent such race conditions going undetected.
=head2 Multiple Moves
If you have multiple same-group result objects already loaded from storage,
you need to be careful when executing C<move_*> operations on them:
without a L</position_column> reload the L</_position_value> of the
"siblings" will be out of sync with the underlying storage.
Starting from version C<0.082800> DBIC will implicitly perform such
reloads when the C<move_*> happens as a part of a transaction
(a good example of such situation is C<< $ordered_resultset->delete_all >>).
If it is not possible for you to wrap the entire call-chain in a transaction,
you will need to call L<DBIx::Class::Row/discard_changes> to get an object
up-to-date before proceeding, otherwise undefined behavior will result.
=head2 Default Values
Using a database defined default_value on one of your group columns
could result in the position not being assigned correctly.
=head1 FURTHER QUESTIONS?
Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
=head1 COPYRIGHT AND LICENSE
This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
|