ADD details in documentation for DepotComponent

.editorconfig

@@ -0,0 +1,13 @@
+# Top-most EditorConfig file
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = UTF-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

README.md

@@ -36,6 +36,17 @@ Add the following basic six files:
 
 ##### 1. DepotComponent.php
 This file contains class for the extension. The class extends MVCComponent.
+Compare this version with the original at [Tech Fry Tutorium](https://www.techfry.com/joomla/adding-basic-files-for-component).
+```php
+namespace KW4NZ\Component\Depot\Administrator\Extension;
+
+use Joomla\CMS\Extension\MVCComponent;
+
+class DepotComponent extends MVCComponent
+{
+
+}
+```
 
 ##### 2. provider.php
 This is a special file that tells Joomla how to initialize the component - which

admin/services/provider.php

@@ -16,7 +16,6 @@ use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
 use Joomla\DI\Container;
 use Joomla\DI\ServiceProviderInterface;
 use KW4NZ\Component\Depot\Administrator\Extension\DepotComponent;
-use Joomla\CMS\Extension\MVCComponent;
 
 return new class implements ServiceProviderInterface
 {

admin/sql/install.mysql.utf8.sql

@@ -1,49 +0,0 @@
--- @package		Depot.SQL MariaDB
--- @subpackage	com_depot
--- @author		Thomas Kuschel <thomas@kuschel.at>
--- @copyright	(C) 2023 KW4NZ, <https://www.kuschel.at>
--- @license		GNU General Public License version 2 or later; see LICENSE.md
--- @since		0.0.1
-
-DROP TABLE IF EXISTS `#__depot`;
-CREATE TABLE `#__depot`(
-	`id` SERIAL,
-	`component_name` VARCHAR(1024) CHARACTER SET ascii COLLATE ascii_general_ci NULL DEFAULT NULL
-		COMMENT 'unique component name (ASCII characters only)',
-	`alias` VARCHAR(1024) NOT NULL DEFAULT '',
-	`description` VARCHAR(4000) NOT NULL DEFAULT '',
-	`quantity` INT(10) UNSIGNED NOT NULL DEFAULT 0,
-	`quantity_exp` INT(11) NOT NULL DEFAULT 0 COMMENT 'Exponent of the quantity (10^x of the number, usually 0 i.e. 10⁰)',
-	`asset_id` INT(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT 'FK to the #__assets table.',
-	`created` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
-	`created_by` INT(10) UNSIGNED NOT NULL DEFAULT 0,
-	`checked_out` INT(11) NOT NULL DEFAULT 0,
-	`checked_out_time` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
-	`modified` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
-	`modified_by` INT(10) UNSIGNED NOT NULL DEFAULT 0,
-	`path` VARCHAR(400) NOT NULL DEFAULT '',
-	`state` TINYINT(4) NOT NULL DEFAULT 0 COMMENT 'Published=1,Unpublished=0,Archived=2,Trashed=-2',
-	`access` TINYINT(4) NOT NULL DEFAULT 0,
-	`params` VARCHAR(1024) NOT NULL DEFAULT '',
-	`image` VARCHAR(1024) NOT NULL DEFAULT '',
-	`ordering` INT(11) NOT NULL DEFAULT 0,
-	`version` int unsigned NOT NULL DEFAULT 1,
-	-- references to other tables:
-	`category_id` INT(11) NOT NULL DEFAULT 0,
-	`datasheet_id` INT(11) NOT NULL DEFAULT 0,
-	`datasheet_alt` VARCHAR(1024) NOT NULL DEFAULT '',
-	`manufacturer_id` INT(11) NOT NULL DEFAULT 0,
-	`stock_id` INT(11) NOT NULL DEFAULT 0,
-	PRIMARY KEY (`id`),
-	KEY `idx_state` (`state`),
-	KEY `idx_stock_id` (`stock_id`),
-	KEY `idx_manufacturer` (`manufacturer_id`),
-	UNIQUE KEY `aliasindex` (`alias`,`manufacturer_id`,`stock_id`)
-)	ENGINE=InnoDB
-	AUTO_INCREMENT=0
-	DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
-
-INSERT INTO `#__depot` (`component_name`,`alias`,`description`,`quantity`,`created`,
- `ordering`,`state`,`manufacturer_id`) VALUES
- ('1N5404','1n5404','diode, rectifier 3A',9,'2023-09-25 15:00:00',1,1,1),
- ('1N4148','1n4148','diode, general purpose',1234,'2023-09-25 15:15:15',2,1,2);

admin/sql/uninstall.mysql.utf8.sql

@@ -1,8 +0,0 @@
--- @package		Depot.Language
--- @subpackage	com_depot
--- @author		Thomas Kuschel <thomas@kuschel.at>
--- @copyright	(C) 2023 KW4NZ, <https://www.kuschel.at>
--- @license		GNU General Public License version 2 or later; see LICENSE.md
--- @since		0.0.1
-
-DROP TABLE IF EXISTS `#__depot`;

admin/src/Extension/DepotComponent.php

@@ -14,5 +14,4 @@ use Joomla\CMS\Extension\MVCComponent;
 
 class DepotComponent extends MVCComponent
 {
-
+}
-}

depot.xml

@@ -26,7 +26,6 @@
 		</submenu>
 		<files folder="admin">
 			<folder>services</folder>
-			<folder>sql</folder>
 			<folder>src</folder>
 			<folder>tmpl</folder>
 		</files>
@@ -35,14 +34,4 @@
 			<language tag="en-GB">en-GB/com_depot.sys.ini</language>
 		</languages>
 	</administration>
-	<install> <!-- Runs on install -->
-		<sql>
-			<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
-		</sql>
-	</install>
-	<uninstall> <!-- Runs on uninstall -->
-		<sql>
-			<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
-		</sql>
-	</uninstall>
 </extension>