Skip to content

Commit 4e5db76

Browse files
committed
Clean up headers in interfaces docs
1 parent 06c87ac commit 4e5db76

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/interfaces.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,23 @@ For advanced usage of the upload plugin, you will need to implement
55
one or more of the followng interfaces.
66

77

8-
Josegonzalez\Upload\File\Path\ProcessorInterface
8+
ProcessorInterface
99
~~~~~~~~~~~~~~~~~~
1010

11+
Fully-namespaced class name: ``Josegonzalez\Upload\File\Path\ProcessorInterface``
12+
1113
This interface is used to create a class that knows how to build paths for a given file upload. Other than the constructor, it contains two methods:
1214

1315
- ``basepath``: Returns the basepath for the current field/data combination
1416
- ``filename`: Returns the filename for the current field/data combination
1517
1618
Refer to ``Josegonzalez\Upload\File\Path\DefaultProcessor`` for more details.
1719

18-
Josegonzalez\Upload\File\Transformer\TransformerInterface
20+
TransformerInterface
1921
~~~~~~~~~~~~~~~~~~~~
2022

23+
Fully-namespaced class name: ``Josegonzalez\Upload\File\Transformer\TransformerInterface``
24+
2125
This interface is used to transform the uploaded file into one or more files that will be written somewhere to disk. This can be useful in cases where you may wish to use an external library to extract thumbnails or create PDF previews. The previous image manipulation functionality should be created at this layer.
2226

2327
Other than the constructor, it contains one method:
@@ -29,6 +33,8 @@ Refer to ``Josegonzalez\Upload\File\Transformer\DefaultTransformer`` for more de
2933
WriterInterface
3034
~~~~~~~~~~~~~~~
3135

36+
Fully-namespaced class name: ``Josegonzalez\Upload\File\Writer\WriterInterface``
37+
3238
This interface is used to actually write files to disk. It writes files to disk using the ``Flysystem`` library, and defaults to local storage by default. Implement this interface if you want to customize the file writing process.
3339

3440
Other than the constructor, it contains one methods:

0 commit comments

Comments
 (0)