From: Jesse Sheidlower Date: Wed, 31 Jan 2007 23:59:06 +0000 (+0000) Subject: Doc cleanup in Ordered.pm X-Git-Tag: v0.08010~190 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=a8492531e6cd58c5031a90aada50fe3147c0ba9c;p=dbsrgits%2FDBIx-Class.git Doc cleanup in Ordered.pm --- diff --git a/lib/DBIx/Class/Ordered.pm b/lib/DBIx/Class/Ordered.pm index 8e2c74d..35ceba4 100644 --- a/lib/DBIx/Class/Ordered.pm +++ b/lib/DBIx/Class/Ordered.pm @@ -19,7 +19,7 @@ Create a table for your ordered data. ); # Optional: group_id INTEGER NOT NULL -In your Schema or DB class add Ordered to the top +In your Schema or DB class add "Ordered" to the top of the component list. __PACKAGE__->load_components(qw( Ordered ... )); @@ -31,7 +31,7 @@ each row. __PACKAGE__->position_column('position'); __PACKAGE__->grouping_column('group_id'); # optional -Thats it, now you can change the position of your objects. +That's it, now you can change the position of your objects. #!/use/bin/perl use My::Item; @@ -73,7 +73,7 @@ move a record it always causes other records in the list to be updated. __PACKAGE__->position_column('position'); Sets and retrieves the name of the column that stores the -positional value of each record. Default to "position". +positional value of each record. Defaults to "position". =cut @@ -83,7 +83,7 @@ __PACKAGE__->mk_classdata( 'position_column' => 'position' ); __PACKAGE__->grouping_column('group_id'); -This method specified a column to limit all queries in +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. @@ -96,7 +96,7 @@ __PACKAGE__->mk_classdata( 'grouping_column' ); my $rs = $item->siblings(); my @siblings = $item->siblings(); -Returns either a result set or an array of all other objects +Returns either a resultset or an array of all other objects excluding the one you called it on. =cut @@ -120,7 +120,7 @@ sub siblings { my $sibling = $item->first_sibling(); Returns the first sibling object, or 0 if the first sibling -is this sibliing. +is this sibling. =cut @@ -139,7 +139,7 @@ sub first_sibling { my $sibling = $item->last_sibling(); -Return the last sibling, or 0 if the last sibling is this +Returns the last sibling, or 0 if the last sibling is this sibling. =cut @@ -160,8 +160,8 @@ sub last_sibling { my $sibling = $item->previous_sibling(); -Returns the sibling that resides one position back. Undef -is returned if the current object is the first one. +Returns the sibling that resides one position back. Returns undef +if the current object is the first one. =cut @@ -182,8 +182,8 @@ sub previous_sibling { my $sibling = $item->next_sibling(); -Returns the sibling that resides one position foward. Undef -is returned if the current object is the last one. +Returns the sibling that resides one position forward. Returns undef +if the current object is the last one. =cut @@ -205,9 +205,9 @@ sub next_sibling { $item->move_previous(); -Swaps position with the sibling on position previous in the list. -1 is returned on success, and 0 is returned if the objects is already -the first one. +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 @@ -221,8 +221,9 @@ sub move_previous { $item->move_next(); -Swaps position with the sibling in the next position. 1 is returned on -success, and 0 is returned if the object is already the last in the list. +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 @@ -238,8 +239,8 @@ sub move_next { $item->move_first(); -Moves the object to the first position. 1 is returned on -success, and 0 is returned if the object is already the 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 @@ -252,8 +253,8 @@ sub move_first { $item->move_last(); -Moves the object to the very last position. 1 is returned on -success, and 0 is returned if the object is already the last one. +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 @@ -267,9 +268,9 @@ sub move_last { $item->move_to( $position ); -Moves the object to the specified position. 1 is returned on -success, and 0 is returned if the object is already at the -specified position. +Moves the object to the specified position. Returns 1 on +success, and 0 if the object is already at the specified +position. =cut @@ -331,7 +332,7 @@ need to use them. =head2 _grouping_clause -This method returns a name=>value pare for limiting a search +This method returns a name=>value pair for limiting a search by the collection column. If the collection column is not defined then this will return an empty list. @@ -364,7 +365,7 @@ ORDER BY on updates. If a position is not specified for an insert than a position will be chosen based on COUNT(*)+1. But, it first selects the -count then inserts the record. The space of time between select +count, and then inserts the record. The space of time between select and insert introduces a race condition. To fix this we need the ability to lock tables in DBIC. I've added an entry in the TODO about this.