Differences

This shows you the differences between two versions of the page.

--- examples:builder:multi_attachment [2020/09/18 20:06]
pdsci
+++ examples:builder:multi_attachment [2021/12/09 10:56] (current)
pdsci-admin [Multiple media/file attachment: attachMany]
@@ Line 2: / Line 2: @@
 ====== Multiple media/file attachment: attachMany ======
-With the //attachMany// function multiple files like images, movies or documents can be attached to a record of a database table. Media attachments are using built-in relations of OctoberCMS. So it is very easy to implement them.
+With the //attachMany// function multiple files like images, movies or documents can be attached to a record of a database table. Media attachments are using built-in relations of WinterCMS. So it is very easy to implement them.
 <WRAP tip>
@@ Line 18: / Line 18: @@
 \\
 \\
+===== Preparation =====
+Prerequisites are\\
+  * an installed [[https://octobercms.com/plugin/rainlab-builder|builder plugin]]
+  * any source code editor or e.g. the [[https://octobercms.com/plugin/indikator-devtools|Developer Tools]] plugin with built-in Code editor like to be seen on the screenshoots
+  * a database table for records to attach the media to
+  * a form (at least in backend) to display the media
+  * some media already uploaded to the media manager or ready to do so
+Required skills\\
+  * how to work with builder
+  * how to create a plugin with builder
+  * how to create tables and forms with builder
+===== Step 1: Extend the base model =====
+The base model requires to know the type of desired relation as well as the name of the relation. This name can be seen like a field name of a database-table.\\
+The base model is located in the plugin directory, subdirectory //models// using the singular of the related db-table name. In our example in the namspace //pds// the plugin //library// with a //book// model this is:\\
+    /pds/library/models/book.php
+Here, the //attachMany// relation has to be inserted:\\
+{{:examples:builder:attachmany.2.model-extension.jpg?direct&960 |}}\\
+<WRAP clear />
+\\
+These are the lines of code to add for the library example to add images of book covers with a new related field called //pageviews//.\\ Notice, that the chosen name for this new field must not exist already in the parent table where the related image will be attached to!\\
+<sxh php>
+    // add a relation for a SINGLE image, field name is 'cover'
+    // this table must not have a field named 'cover' !
+    public $attachMany = [
+        'pageviews' => ['System\Models\File', 'public' => false]
+    ];
+</sxh>
+\\
+===== Step 2: Prepare the form =====
+Next step is to complete the form with an additional field - the **File upload** widget to upload and display media and/or files:\\
+{{:examples:builder:attachmany.3.field.jpg?direct&960 |Add widget fileUpload}}
+<WRAP clear />
+\\
+===== Step 3: Upload media/files =====
+Finally, in the backend form view of the plugin, a file can be uploaded by clicking on the //file upload symbol// - the area below the 'Page Views' title in the example:\\
+{{:examples:builder:attachmany.4.final-upload.jpg?direct&960 |}}
+<WRAP clear />
+\\
+Now the form is ready to attach multiple images and/or files to each record.\\
+----
+\\
+Back to [[:start|Start Page]]