Merge pull request #2941 from torleif/patch-3

Updated find_or_make() documentation
This commit is contained in:
Simon Welsh 2014-03-15 21:55:06 +13:00
commit d28a323fbd

View File

@ -40,11 +40,13 @@ class Folder extends File {
/**
* Find the given folder or create it both as {@link Folder} database records
* and on the filesystem. If necessary, creates parent folders as well.
* and on the filesystem. If necessary, creates parent folders as well. If it's
* unable to find or make the folder, it will return null (as /assets is unable
* to be represented by a Folder DataObject)
*
* @param $folderPath string Absolute or relative path to the file.
* If path is relative, its interpreted relative to the "assets/" directory.
* @return Folder
* @return Folder|null
*/
public static function find_or_make($folderPath) {
// Create assets directory, if it is missing