Bearbeiten von „PhpPackage“

[[Kategorie:Programmierung]]

= Links =
* [[PhpDebugger]]
* [[PHP]]
* [[PhpPackage]]
* https://dev.to/timoschinkel/good-practices-when-working-with-composer-5a1c

= Zielsetzung =
Leitfaden, wie ein PHP-Package erzeugt wird, wie es eingebunden wird.

= Installation =
<syntaxhighlight lang="bash">
apt install composer
</syntaxhighlight>

= Erzeugen eines Php-Packages =
Das Erzeugen erfolgt interaktiv:
<syntaxhighlight lang="bash">
composer init
</syntaxhighlight>
Wichtig für Benennen des Packages:
* Paketname: hamatoma/my_super_package Namespace: Hamatoma/MySuperPackage
* Paketname: hamatoma-only/my-super-package Namespace: HamatomaOnly\MySuperPackage
<pre>
Package name (<vendor>/<name>) [hamatoma/my_super_package]: # Kleinbuchstaben. Namespace:
Description: My super Package
Author: Hamatoma <author@hamatoma.de>
Minimum Stability: dev # oder  alpha, beta, RC, stable
Package Type (e.g. library, project, metapackage, composer-plugin): library
License []: CC0 1.0 Universal
Would you like to define your dependencies (require) interactively: yes
Search for a package: the_ultimate_package
 Found 3 packages matching the_ultimate_package
   [0] fjerbi/ultimateblog 
   [1] assegaiphp/validation 
   [2] ingress-it-solutions/laravel-google-my-business 
Enter the version constraint to require (or leave blank to use the latest version):
...
Would you like to define your dev dependencies (require-dev) interactively: no

Add PSR-4 autoload mapping? Maps namespace "Hamatoma\MySuperPackage" to the path [src/ n to skip]: /src
Do you confirm generation [yes]
Would you like to install dependencies now [yes]?
</pre>

= Kochbuch =
== Aktualisieren ==
<syntaxhighlight lang="bash">
composer update
</syntaxhighlight>

== Entwicklung-Produktion ==
* https://stackoverflow.com/questions/21721495/how-to-deploy-correctly-when-using-composers-develop-production-switch
* <code>composer install {--dev | --no-dev}</code>, default ist <code>--dev</code>
* <code>composer update {--dev | --no-dev}</code>, default ist <code>--dev</code>

== Autoloaderdaten generieren ==
<syntaxhighlight lang="bash">
composer dump-autoload
</syntaxhighlight>
== Einbinden in Startseite index.php ==
<pre>
require_once 'Hamatoma/MySuperPackage';
$class = new \Hamatoma\MySuperPackage\MyClass();
</pre>
== Einbinden in Projekt MyPhpProject ==
<syntaxhighlight lang="bash">
composer require hamatoma/my_super_package
</syntaxhighlight>

== Einbinden eines lokalen Pakets ==
* composer.json
<pre>
"repositories": [
    {
        "type": "path",
        "url": "../my-package",
        "options": {
            "symlink": true
        }
    }
],
...
"minimum-stability": "dev",
</pre>

== Einbinden eines Github-Repository ==
* composer.json
* Der Branch wird in "require" hinter "dev-" angegeben, z.B. "dev-master"
<syntaxhighlight lang="bash">
composer config repositories.laraknife vcs https://github.com/hamatoma/laraknife
# Branch main:
composer require hamatoma/laraknife:dev-main
</syntaxhighlight>
* Das ergibt dann:
<pre>
    "repositories": [
        "laraknife": {
            "type": "vcs",
            "url": "https://github.com/hamatoma/laraknife"
        }
    ],
    "require": {
        "hamatoma/laraknife": "dev-main"
    }
}
...
"minimum-stability": "dev",
</pre>