Skip to content

docs: improve files.rst #5412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulbalandan merged 3 commits into from
Dec 3, 2021
Merged

docs: improve files.rst #5412

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f646b9c
docs: update sample code coding style
kenjis Nov 30, 2021
afdc976
docs: decorate method/variable with '``'
kenjis Nov 30, 2021
78cf411
docs: add / to separate methods
kenjis Nov 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions user_guide_src/source/libraries/files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,17 @@ Moving Files
Each file can be moved to its new location with the aptly named ``move()`` method. This takes the directory to move
the file to as the first parameter::

$file->move(WRITEPATH.'uploads');
$file->move(WRITEPATH . 'uploads');

By default, the original filename was used. You can specify a new filename by passing it as the second parameter::

$newName = $file->getRandomName();
$file->move(WRITEPATH.'uploads', $newName);
$file->move(WRITEPATH . 'uploads', $newName);

The move() method returns a new File instance that for the relocated file, so you must capture the result if the
resulting location is needed::

$file = $file->move(WRITEPATH.'uploads');
$file = $file->move(WRITEPATH . 'uploads');

****************
File Collections
Expand Down Expand Up @@ -136,8 +136,7 @@ When your collection is complete, you can use ``get()`` to retrieve the final li
echo 'My files: ' . implode(PHP_EOL, $files->get());
echo 'I have ' . count($files) . ' files!';

foreach ($files as $file)
{
foreach ($files as $file) {
echo 'Moving ' . $file->getBasename() . ', ' . $file->getSizeByUnit('mb');
$file->move(WRITABLE . $file->getRandomName());
}
Expand All @@ -150,7 +149,7 @@ Starting a Collection
**__construct(string[] $files = [])**

The constructor accepts an optional array of file paths to use as the initial collection. These are passed to
**add()** so any files supplied by child classes in the **$files** will remain.
``add()`` so any files supplied by child classes in the ``$files`` will remain.

**define()**

Expand Down Expand Up @@ -181,17 +180,17 @@ Inputting Files
Adds all files indicated by the path or array of paths. If the path resolves to a directory then ``$recursive``
will include sub-directories.

**addFile(string $file)**
**addFile(string $file)** /
**addFiles(array $files)**

Adds the file or files to the current list of input files. Files are absolute paths to actual files.

**removeFile(string $file)**
**removeFile(string $file)** /
**removeFiles(array $files)**

Removes the file or files from the current list of input files.

**addDirectory(string $directory, bool $recursive = false)**
**addDirectory(string $directory, bool $recursive = false)** /
**addDirectories(array $directories, bool $recursive = false)**

Adds all files from the directory or directories, optionally recursing into sub-directories. Directories are
Expand All @@ -200,7 +199,7 @@ absolute paths to actual directories.
Filtering Files
===============

**removePattern(string $pattern, string $scope = null)**
**removePattern(string $pattern, string $scope = null)** /
**retainPattern(string $pattern, string $scope = null)**

Filters the current file list through the pattern (and optional scope), removing or retaining matched
Expand Down