* - nonJournaled : Don't log this operation batch in the file journal.
* This limits the ability of recovery scripts.
* - parallelize : Try to do operations in parallel when possible.
- * - bypassReadOnly : Allow writes in read-only mode (@since 1.20).
+ * - bypassReadOnly : Allow writes in read-only mode (since 1.20).
*
* @remarks Remarks on locking:
* File system paths given to operations should refer to files that are
* - move
* - delete
* - null
+ *
* a) Create a new file in storage with the contents of a string
* @code
* array(
* nothing if the source file does not exist.
*
* $opts is an associative of boolean flags, including:
- * - bypassReadOnly : Allow writes in read-only mode (@since 1.20)
+ * - bypassReadOnly : Allow writes in read-only mode (since 1.20)
*
* @par Return value:
* This returns a Status, which contains all warnings and fatals that occured
*
* $params include:
* - dir : storage directory
- * - noAccess : try to deny file access (@since 1.20)
- * - noListing : try to deny file listing (@since 1.20)
- * - bypassReadOnly : allow writes in read-only mode (@since 1.20)
+ * - noAccess : try to deny file access (since 1.20)
+ * - noListing : try to deny file listing (since 1.20)
+ * - bypassReadOnly : allow writes in read-only mode (since 1.20)
*
* @param $params Array
* @return Status
* - dir : storage directory
* - noAccess : try to deny file access
* - noListing : try to deny file listing
- * - bypassReadOnly : allow writes in read-only mode (@since 1.20)
+ * - bypassReadOnly : allow writes in read-only mode (since 1.20)
* @return Status
*/
final public function secure( array $params ) {
* - dir : storage directory
* - access : try to allow file access
* - listing : try to allow file listing
- * - bypassReadOnly : allow writes in read-only mode (@since 1.20)
+ * - bypassReadOnly : allow writes in read-only mode (since 1.20)
*
* @param $params Array
* @return Status
* @param $params Array
* $params include:
* - dir : storage directory
- * - recursive : recursively delete empty subdirectories first (@since 1.20)
- * - bypassReadOnly : allow writes in read-only mode (@since 1.20)
+ * - recursive : recursively delete empty subdirectories first (since 1.20)
+ * - bypassReadOnly : allow writes in read-only mode (since 1.20)
* @return Status
*/
final public function clean( array $params ) {
* @param $params array
* $params include:
* - dir : storage directory
- * - topOnly : only return direct child files of the directory (@since 1.20)
+ * - topOnly : only return direct child files of the directory (since 1.20)
* @return Traversable|Array|null Returns null on failure
*/
abstract public function getFileList( array $params );