Author: agilbert
Date: 2010-01-14 23:04:38 +0100 (Thu, 14 Jan 2010)
New Revision: 26654
Modified:
plugins/pkToolkitPlugin/trunk/lib/pkArray.class.php
Log:
getIds works on arrays now. added some phpDoc formatting.
Modified: plugins/pkToolkitPlugin/trunk/lib/pkArray.class.php
===================================================================
--- plugins/pkToolkitPlugin/trunk/lib/pkArray.class.php 2010-01-14 21:25:17 UTC
(rev 26653)
+++ plugins/pkToolkitPlugin/trunk/lib/pkArray.class.php 2010-01-14 22:04:38 UTC
(rev 26654)
@@ -1,76 +1,97 @@
<?php
-// TBB: these may seem trivial but they eliminate a lot of dumb
-// tests and gratuitous loop variables and accidental bugs in templates.
-
-// I was passing things by reference unnecessarily. That is fixed.
-
+/**
+ * TBB: these may seem trivial but they eliminate a lot of dumb
+ * tests and gratuitous loop variables and accidental bugs in templates.
+ *
+ * I was passing things by reference unnecessarily. That is fixed.
+ */
class pkArray
{
- // Return first element of array. If there isn't one, or it's
- // not an array, or it's not set, return false.
+ /**
+ * Return first element of array. If there isn't one, or it's
+ * not an array, or it's not set, return false.
+ */
public static function first($array)
{
- if (isset($array) && (is_array($array)) && (count($array) > 0)) {
+ if (isset($array) && (is_array($array)) && (count($array) > 0))
+ {
return $array[0];
- } else {
+ }
+ else
+ {
return false;
}
}
- // Return last element of array. If there isn't one, or it's
- // not an array, or it's not set, return false.
+
+ /**
+ * Return last element of array. If there isn't one, or it's
+ * not an array, or it's not set, return false.
+ */
public static function last($array)
{
- if (isset($array) && (is_array($array)) && (count($array) > 0)) {
+ if (isset($array) && (is_array($array)) && (count($array) > 0))
+ {
return $array[count($array) - 1];
- } else {
+ }
+ else
+ {
return false;
}
}
-
- // "One of these fields is bound to contain something interesting..."
- // Returns the first value in the array that isn't made up entirely
- // of trimmable whitespace.
+
+ /**
+ * "One of these fields is bound to contain something interesting..."
+ * Returns the first value in the array that isn't made up entirely
+ * of trimmable whitespace.
+ */
public static function firstNontrivial($array)
{
- foreach ($array as $value) {
- if (strlen(trim($value))) {
+ foreach ($array as $value)
+ {
+ if (strlen(trim($value)))
+ {
return $value;
}
}
return false;
}
-
- // Sort an array by the stringification of each element.
- // Works for objects; would work fine for strings too.
- // Why this is not standard is a mystery to me.
+
+ /**
+ * Sort an array by the stringification of each element.
+ * Works for objects; would work fine for strings too.
+ * Why this is not standard is a mystery to me.
+ */
public static function sort(&$array)
{
return usort($array, array('pkArray', 'compare'));
}
-
- // Same idea, case insensitive.
+
+ /**
+ * Same idea, case insensitive.
+ */
public static function sortInsensitive(&$array)
{
return usort($array, array('pkArray', 'compareInsensitive'));
}
-
- // Like array_search, this method returns the offset of the
- // value within the array, if it is present, false otherwise.
-
- // However, 'strict' has three possible values, extending its meaning in
- // the standard PHP array functions:
-
- // false: items are compared with ==
-
- // true: items are compared with ===
-
- // 'id': items are compared with the getId() method of the values,
- // which must be objects
-
- // If you find yourself calling this often in a loop, though, promise me
- // you'll create an associative array instead.
-
+
+ /**
+ * Like array_search, this method returns the offset of the
+ * value within the array, if it is present, false otherwise.
+ *
+ * However, 'strict' has three possible values, extending its meaning in
+ * the standard PHP array functions:
+ *
+ * false: items are compared with ==
+ *
+ * true: items are compared with ===
+ *
+ * 'id': items are compared with the getId() method of the values,
+ * which must be objects
+ *
+ * If you find yourself calling this often in a loop, though, promise me
+ * you'll create an associative array instead.
+ */
public static function search($array, $value, $strict)
{
if ($strict === 'id')
@@ -88,21 +109,24 @@
return $i;
}
}
+
return false;
}
+
return array_search($array, $value, $strict);
}
- // Search the array, find the item, return the index of the *previous*
- // item. If wrap is specified, a request for the first item
- // returns the last item, otherwise it returns false. If the
- // array is empty this function always returns false. If the item is
- // not in the array this function always returns false. If the
- // array is one element long the index of that element is returned.
- // Uses pkArray::search(), so 'id' is an allowed value for $strict.
-
- // This is great for creating "Previous" links.
-
+ /**
+ * Search the array, find the item, return the index of the *previous*
+ * item. If wrap is specified, a request for the first item
+ * returns the last item, otherwise it returns false. If the
+ * array is empty this function always returns false. If the item is
+ * not in the array this function always returns false. If the
+ * array is one element long the index of that element is returned.
+ * Uses pkArray::search(), so 'id' is an allowed value for $strict.
+ *
+ * This is great for creating "Previous" links.
+ */
public static function before($array, $value, $strict = false, $wrap = false)
{
$index = self::search($array, $value, $strict);
@@ -121,19 +145,21 @@
return false;
}
}
+
return $index - 1;
}
- // Search the array, find the item, return the index of the *next*
- // item. If wrap is specified, a request for the last item
- // returns the first item, otherwise it returns false. If the
- // array is empty this function always returns false. If the item is
- // not in the array this function always returns false. If the
- // array is one element long the index of that sole element is returned.
- // Uses pkArray::search(), so 'id' is an allowed value for $strict.
-
- // This is great for creating "Next" links.
-
+ /**
+ * Search the array, find the item, return the index of the *next*
+ * item. If wrap is specified, a request for the last item
+ * returns the first item, otherwise it returns false. If the
+ * array is empty this function always returns false. If the item is
+ * not in the array this function always returns false. If the
+ * array is one element long the index of that sole element is returned.
+ * Uses pkArray::search(), so 'id' is an allowed value for $strict.
+ *
+ * This is great for creating "Next" links.
+ */
public static function after($array, $value, $strict = false, $wrap = false)
{
$index = self::search($array, $value, $strict);
@@ -152,20 +178,38 @@
return false;
}
}
+
return $index + 1;
}
- // Given an array of objects, return an array of ids
- // obtained by calling getId() on each (but see listToHashById)
-
+ /**
+ * Given an array of objects or arrays, return an array of ids
+ * obtained by either calling getId() on each object or returning the 'id'
+ * value of each child array.
+ *
+ * @see listToHashById
+ */
public static function getIds($array)
{
- return self::getResultsForMethod($array, 'getId');
+ if (count($array) === 0)
+ {
+ return array();
+ }
+
+ if ($array[0] instanceof Object)
+ {
+ return self::getResultsForMethod($array, 'getId');
+ }
+ else
+ {
+ return self::getResultsForKey($array, 'id');
+ }
}
- // Given an array of objects and a method, return an array consisting
- // of the results obtained by calling the method on each object
-
+ /**
+ * Given an array of objects and a method, return an array consisting
+ * of the results obtained by calling the method on each object
+ */
public static function getResultsForMethod($array, $method)
{
$results = array();
@@ -173,12 +217,29 @@
{
$results[] = call_user_func(array($item, $method));
}
+
return $results;
}
- // Given a flat array of objects, returns an associative
- // array indexed by ids as returned by getId()
-
+ /**
+ * Given an array of objects and a method, return an array consisting
+ * of the results obtained by calling the method on each object
+ */
+ public static function getResultsForKey($array, $key)
+ {
+ $results = array();
+ foreach ($array as $item)
+ {
+ $results[] = $item[$key];
+ }
+
+ return $results;
+ }
+
+ /**
+ * Given a flat array of objects, returns an associative
+ * array indexed by ids as returned by getId()
+ */
public static function listToHashById($array)
{
$hash = array();
@@ -186,16 +247,18 @@
{
$hash[$item->getId()] = $item;
}
+
return $hash;
}
- // Given an array of items, rearrange them into subarrays
- // by first letter of their string representation. Useful for directories
- // by first letter. You can specify an alternate callable to be used to fetch
- // the name of the item if conversion to a string doesn't do what you want
- // (for instance, if you're being lazy and using hashes where you really
- // ought to be using an object and defining a __toString() method).
-
+ /**
+ * Given an array of items, rearrange them into subarrays
+ * by first letter of their string representation. Useful for directories
+ * by first letter. You can specify an alternate callable to be used to fetch
+ * the name of the item if conversion to a string doesn't do what you want
+ * (for instance, if you're being lazy and using hashes where you really
+ * ought to be using an object and defining a __toString() method).
+ */
public static function byFirstLetter($array, $getName = null)
{
$alphabet = array_map('chr', range(ord('A'), ord('Z')));
@@ -215,32 +278,37 @@
}
$result[strtoupper(substr($name, 0, 1))][] = $item;
}
+
return $result;
}
-
- // Remove the specified value, if present, from a flat array, returning a
flat array lacking that element.
- // Not for use with associative arrays
-
+
+ /**
+ * Remove the specified value, if present, from a flat array, returning a
flat array lacking that element.
+ * Not for use with associative arrays
+ */
public static function removeValue($a, $v)
{
$a = array_flip($a);
unset($a[$v]);
+
return array_keys($a);
}
- // Helpers for the above.
-
- // Compare two objects as strings via their string conversion methods.
-
+ /**
+ * Helpers for the above.
+ *
+ * Compare two objects as strings via their string conversion methods.
+ */
public static function compare($a, $b)
{
// PHP 5.1.x doesn't apply __toString outside of
// echo and print statements. Grr
$s1 = self::toString($a);
$s2 = self::toString($b);
- # If we knew we were on 5.2.x, we could just do this
- # $s1 = "$a";
- # $s2 = "$b";
+
+ // If we knew we were on 5.2.x, we could just do this
+ // $s1 = "$a";
+ // $s2 = "$b";
if ($s1 == $s2)
{
return 0;
@@ -248,7 +316,9 @@
return ($s1 < $s2) ? -1 : 1;
}
- // Should be PHP 5.1.x-safe
+ /**
+ * Should be PHP 5.1.x-safe
+ */
private static function toString($a)
{
if (is_object($a) && method_exists($a, '__toString'))
@@ -261,21 +331,24 @@
}
}
- // Case insensitive version of the same thing
-
+ /**
+ * Case insensitive version of the same thing
+ */
public static function compareInsensitive($a, $b)
{
// PHP 5.1.x doesn't apply __toString outside of
// echo and print statements. Grr
$s1 = strtolower(self::toString($a));
$s2 = strtolower(self::toString($b));
- # If we knew we were on 5.2.x, we could just do this
- # $s1 = strtolower("$a");
- # $s2 = strtolower("$b");
+
+ // If we knew we were on 5.2.x, we could just do this
+ // $s1 = strtolower("$a");
+ // $s2 = strtolower("$b");
if ($s1 == $s2)
{
return 0;
}
+
return ($s1 < $s2) ? -1 : 1;
}
--
You received this message because you are subscribed to the Google Groups
"symfony SVN" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/symfony-svn?hl=en.
