Added 'orderby' key for alternative sorting

The default is letter and then number, setting the ‘orderby’ key to
SORT_STRING gives you number then letters.

Author: Russell Baldwin

alphabetise.php

@@ -1,21 +1,26 @@
 <?php
-// The Alphabetise plugin for Kirby CMS will Alphabetise a given page array or tag array 
+// The Alphabetise plugin for Kirby CMS will Alphabetise a given page array or tag array
 // and return it for further processing/display
 // The 'key' text field must be longer than a single character.
 // See readme for further information
-// Recent Updates: Fix for single alphabetical index bug #3 initial bug fix problem
+// Recent Updates: Added key for ksort sort_flags - set orderby to SORT_STRING for numbers & then letters
+// Default it is set to SORT_REGLAUR for letters and then numbers
+// 'orderby' key is NOT a string!
 // -----
-// Russ Baldwin 
+// Russ Baldwin
 // shoesforindustry.net
-// v0.0.8
+// v0.0.9
 // -----
 function alphabetise($parent, $options=array()) {
-  
+
   // default key values
-  $defaults = array('key'=> 'title');
-  
+  // As we are using ksort the default 'orderby' is SORT_REGULAR
+  // To sort with number first you can use 'orderby' set to SORT_STRING
+  // Other ksort sort_flags may be usuable but not tested!
+  $defaults = array('key'=> 'title','orderby'=> SORT_REGULAR);
+
   // merge defaults and options
-  $options = array_merge($defaults, $options);  
+  $options = array_merge($defaults, $options);
 
   //Gets the input into a two dimensional array - uses '~' as separator;
   foreach ($parent as $item){
@@ -26,7 +31,7 @@ function alphabetise($parent, $options=array()) {
   }
 
   // Check to see array is not empty
-  if ( (!empty ($array)) )  { 
+  if ( (!empty ($array)) )  {
     //Make an array of key and data
     foreach ($array as $temp => $item){
       if (strlen($temp)<2){
@@ -35,21 +40,21 @@ function alphabetise($parent, $options=array()) {
       } else {
         $array[substr($temp, 0, 1)][]=$item[0];
       }
-      unset ($array[$temp]); 
+      unset ($array[$temp]);
     }
 
     // If all OK $array will be returned and sorted
-    ksort($array);
-  
+  ksort($array,$options['orderby']);
+
   } else {
-    
+
     // There has been a problem so set $array with error message and then return $array
     $array = array(
       "Alphabetise Plugin Error: Problem with array or invalid key!
         Make sure your array is valid, not empty & that the key is valid for this type of array.  (You can probably ignore the errors after this point, until this error has been resolved.)" => "Error"
     );
   }
-  
+
   return $array;
 }
 ?>

readme.mdown

@@ -2,13 +2,13 @@
 
 ## What is it?
 
-The Alphabetise plugin will alphabetise a given [Kirby CMS](http://getkirby.com/) *page* array or *tag* array and return it for further processing/display as an alphabetised array. 
+The Alphabetise plugin will alphabetise a given [Kirby CMS](http://getkirby.com/) *page* array or *tag* array and return it for further processing/display as an alphabetised array.
 
-*The array whose key your are trying to sort on should of course only contain letters of the alphabet, if not problems may occur.* 
+*The array whose key your are trying to sort on should of course only contain letters of the alphabet, if not problems may occur.*
 
 *Also the code (explode) uses a '~' tilde, if you use this in your key, especially at the beginning of the string, then you could run into sorting problems. You could of course manually change it if required.*
 
-## Installation 
+## Installation
 
 Put all the files into your **site/plugins/alphabetise** folderor use the [Kirby CLI](https://github.com/getkirby/cli): In your project folder, from the command line, enter:
 ```kirby plugin:install shoesforindustry/kirby-plugins-alphabetise```  
@@ -34,7 +34,7 @@ In your template call, it like this:
 ```php
 <?php $alphabetise = alphabetise($page->children()->visible()->sortby('title'), array('key' => 'title')); ?>
 ```
-The first argument you pass is the sorted **page** array you want to *alphabetise*. The second array **key** argument is so you can set what you want to *alphabetise* by. It should be a string like a page 'title'. The 'sortby' and the 'key' should usually be the same. 
+The first argument you pass is the sorted **page** array you want to *alphabetise*. The second array **key** argument is so you can set what you want to *alphabetise* by. It should be a string like a page 'title'. The 'sortby' and the 'key' should usually be the same.
 
 You then want to loop through the returned results and display them for example:
 ```php
@@ -47,13 +47,13 @@ You then want to loop through the returned results and display them for example:
      	            <?php echo $item->title()?>
      	         </a>
      	     </li>
-     	   <?php endforeach ?> 
+     	   <?php endforeach ?>
     </ul>
    <hr/>
 <?php endforeach ?>
 ```
 
-####Example2: Alphabetical list of tags using tag name as the key 
+####Example2: Alphabetical list of tags using tag name as the key
 
 #####A
 + Aa tag
@@ -102,7 +102,29 @@ You can use any valid array element, so for tags you can use also add **$item->r
     </li>
 ```	  
 
-  
+####Example3: Set 'orderby' key
+
+Version 0.0.9 adds a key to alter how the array appears, the default is with letters and then numbers e.g.
+
++ A
++ B
++ 1
++ 2
+
+Or you can not set the 'orderby' key to SORT_STRING, to have the numbers listed first e.g.
+
++ 1
++ 2
++ A
++ B
+
+```php
+<?php $alphabetise = alphabetise($page->children()->visible()->sortby('title'), array('key' => 'title', 'orderby'=>SORT_STRING))); ?>
+
+```
+
+**Note**: *We are using 'ksort' so other 'sort_flags' might be possible but not tested!  The 'orderby' key is not a string!*
+
 ## Author
 Russ Baldwin  
-[shoesforindustry.net](shoesforindustry.net)
+[shoesforindustry.net](shoesforindustry.net)