WOOF_Collection :: flatten( String $name, Arguments $args = array(), String $remove_call_args = separator,prefix,suffix )
Returns:
-
String
The flattened property value string.
Flattens the collection to a string made up of a given single property value from each separated by a given separator.
Parameters:
-
The name of the property to extract.
-
An arguments string or array supporting the following parameters:
- seperator (or sep) – the string to use between each proprty value – default “, “
- prefix – specify a prefix to append to the beginning of each property value – default “”
- suffix – specify a suffix to append to the end of each property value – default “”
- args – an array of arguments to pass through to methods representing the property access – default null (not set)
Note that if the args item in the above list is not set, this entire args parameter is passed through to the property method (sans the params specified in the remove_call_args parameter)
-
String $remove_call_args = separator,prefix,suffix
A CSV string of parameter names to exclude from the property access call if the args parameter is not set in the args argument (see above).