summaryrefslogtreecommitdiff
path: root/framework/Util/TDataFieldAccessor.php
diff options
context:
space:
mode:
authorctrlaltca <>2012-11-02 17:21:34 +0000
committerctrlaltca <>2012-11-02 17:21:34 +0000
commit07fd9b44bc5c0b60f90baf9917e492072950f5e5 (patch)
treebdd58b5c54d3970ab82a800f058aeae6e5df6463 /framework/Util/TDataFieldAccessor.php
parent84de259ccb6259d6b052b76f35ee267afb9dea3d (diff)
small doc update
Diffstat (limited to 'framework/Util/TDataFieldAccessor.php')
-rw-r--r--framework/Util/TDataFieldAccessor.php4
1 files changed, 3 insertions, 1 deletions
diff --git a/framework/Util/TDataFieldAccessor.php b/framework/Util/TDataFieldAccessor.php
index e25151db..24fcbd36 100644
--- a/framework/Util/TDataFieldAccessor.php
+++ b/framework/Util/TDataFieldAccessor.php
@@ -35,7 +35,9 @@ class TDataFieldAccessor
/**
* Evaluates the data value at the specified field.
* - If the data is an array, then the field is treated as an array index
- * and the corresponding element value is returned;
+ * and the corresponding element value is returned; the field name can also include
+ * dots to access subarrays. For example a field named 'MyField.MySubField' will
+ * first try to access $data['MyField.MySubField'], then try $data['MyField']['MySubField'].
* - If the data is a TMap or TList object, then the field is treated as a key
* into the map or list, and the corresponding value is returned.
* - If the data is an object, the field is treated as a property or sub-property