JTable/move - Revision history

Batch1211 at 17:51, 11 November 2008

2008-11-11T17:51:19Z

Batch1211 at 08:40, 7 November 2008

2008-11-07T08:40:06Z

Batch1211 at 08:21, 7 November 2008

2008-11-07T08:21:05Z

Batch1211 at 08:19, 7 November 2008

2008-11-07T08:19:59Z

Batch1211: New page: ===Syntax=== ''void'' move ($dirn, [$where = '']) where: {| class="wikitable" !Argument !Data type !Description !Default |- |$dirn |integer |Direction to move the record. $dirn < 0 fo...

2008-11-07T08:08:48Z

New page: ===Syntax=== ''void'' move ($dirn, [$where = '']) where: {| class="wikitable" !Argument !Data type !Description !Default |- |$dirn |integer |Direction to move the record. $dirn < 0 fo...

New page

===Syntax===
''void'' move ($dirn, [$where = ''])

where:
{| class="wikitable"
!Argument
!Data type
!Description
!Default
|-
|$dirn
|integer
|Direction to move the record. $dirn < 0 for up, $dirn > 0 for down.
|
|-
|$where
|string
|Additional where query to limit ordering to a particular subset of records
|
|}

=== Preconditions ===
Your database table must have a column named 'ordering'.

=== What does the method do? ===
The goal of the method is to move a record of the table one step up, or one step down by switching the ordering values with the respective neighbour.
===Example===
Let's say we have the following database-table:
{| class="wikitable"
!id
!greeting
!ordering
|-
|1
|Hello
|5
|-
|2
|Bonjour
|15
|-
|3
|Guten Tag
|3
|-
|4
|Buenos Días
|10
|-
|5
|Nǐ hǎo
|17
|}
We now want to compress the ordering of the table.
<source lang="php">
//We need an instance of the table object. In a controller or model we can do it like this...
$table = $this->getTable('greeting');
//Let's compact the ordering sequence
$table->reorder();
</source>
The first thing the method does is to load the table ordered by the current ordering:
{| class="wikitable"
!id
!greeting
!ordering
|-
|3
|Guten Tag
|3
|-
|1
|Hello
|5
|-
|2
|Bonjour
|15
|}
The next (and last step) is that the method updates the ordering entries so it's a consecutive sequence:
{| class="wikitable"
!id
!greeting
!ordering
|-
|3
|Guten Tag
|1
|-
|1
|Hello
|2
|-
|2
|Bonjour
|3
|}

===See also===
* [[JTable/move]]
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JTable]]</noinclude>

← Older revision		Revision as of 08:40, 7 November 2008
Line 1:		Line 1:
		+	{{review}}
	===Syntax===		===Syntax===
	''void'' move ($dirn, [$where = ''])		''void'' move ($dirn, [$where = ''])

@@ Line 73: / Line 73: @@
 |}
 The next (and last step) is that the method switches the ordering values of both records.
 '''Before:'''
 {| class="wikitable"

@@ Line 3: / Line 3: @@
 ''void''   move  ($dirn, [$where = ''])
-where:
+=== Parameters ===
 {| class="wikitable"
 !Argument
@@ Line 20: / Line 20: @@
+|
 |}
 === Preconditions ===

@@ Line 52: / Line 52: @@
 |17
 |}
-We now want to compress the ordering of the table.
+We now want to move down the entry 'Hello' one step.
 <source lang="php">
 //We need an instance of the table object. In a controller or model we can do it like this...
 $table = $this->getTable('greeting');
-//Let's compact the ordering sequence
+//We need to load the 'Hello' entry into the table object. The id (which is the primary key of the table) of this entry is 1.
-$table->reorder();
+$table->load(1);
 </source>
-The first thing the method does is to load the table ordered by the current ordering:
+The first thing the method does is to load the record which has the next higher ordering value. (If our $dirn paremeter would have been negative, it would have loaded the record with the next lower ordering value. In our case, this is the record with the id #4.
 {| class="wikitable"
 !id
@@ Line 65: / Line 68: @@
 !ordering
 |-
-|3
+|4
-|Guten Tag
+|Buenos Días
-|3
+|10
 |-
 |1
@@ Line 73: / Line 83: @@
 |5
 |-
-|2
+|4
-|Bonjour
+|Buenos Días
-|15
+|10
 |}
-The next (and last step) is that the method updates the ordering entries so it's a consecutive sequence:
+'''After:'''
 {| class="wikitable"
 !id
@@ Line 83: / Line 93: @@
 !ordering
 |-
 |1
 |-
 |1
 |Hello
-|2
+|10
 |-
 |2
 |Bonjour
 |3
 |}
 ===See also===
-* [[JTable/move]]
+* [[JTable/reorder]]
 <noinclude>[[Category:Development]][[Category:Framework]][[Category:JTable]]</noinclude>