Composer package készítés

Saját csomagok segítségével modulárisan építhetőek fel a programok, így különböző funkciók, osztályok vagy függvények különálló csomagokba helyezhetőek, amelyek újra felhasználhatók más projekteken. Ez javítja a kód organizáltságát és a fejlesztés hatékonyságát.

1. lépés

Hozz létre egy új könyvtárat a csomagnak, és lépj be ebbe a könyvtárba.

2. lépés

Hozz létre egy composer.json fájlt a csomag főkönyvtárában, továbbá a főkönyvtárban egy src mappát is ahová a forráskód kerül.

composer.json fájl tartalma:

{
  "name": "gyökérkönyvtár/könyvtár",
  "description": "Ez egy példa Composer library.",
  "type": "library",
  "license": "MIT",
  "authors": [
    {
      "name": "Készítő neve",
      "email": "teszt@pelda.com"
    }
  ],
  "autoload": {
    "psr-4": {
      "Példafájl\\Library\\": "src/"
    }
  },
  "require": {
    "php": "^7.4"
  },
  "minimum-stability": "dev"
  "prefer-stable": true
}

A "name" kulcs értéke "gyökérkönyvtár/könyvtár", amely azonosítja a könyvtárat a Packagist számára. A "description" kulcs értéke "Ez egy példa Composer library.", amely rövid leírást ad a könyvtárról. A "authors" kulcs alatt megadhatod a könyvtár szerzőjének adatait. A megadott példában a szerző neve "Készítő neve" és az email címe "teszt@pelda.com". Az "autoload" kulcs alatt meghatározhatod az autoload beállításokat. A megadott példában a "psr-4" autoload-osztálybetöltőt használjuk, és a Példafájl\\Library\\ névtér tartalmát a "src/" könyvtárban található fájlokkal társítjuk. A "require" kulcs alatt meghatározhatod a kötelező függőségeket. A példában az "php" verziója legalább 7.4-nek kell lennie.

Csomag könyvtár struktúra:

Példa forráskód

3. lépés

Fájlok feltöltése egy verziókövető rendszerbe pl: GitHub, GitLab stb.. (A brancheket érdemes az aktuális verzióra nevezni.)

4. lépés

- Packagist felhasználói fiók készítése
- Submit (jobb felső gomb a navigációs menüben)
- Repository URL megadása
- Új verzió esetén (pl. új branch) updatelni kell a projektet

5. lépés

Csomag használatához a következő parancsot kell futtatni terminálban:

php composer.phar require gyökérkönyvtár/könyvtár "branch/verzió"

A letöltött csomag a vendor mappában lesz a gyökérkönyvtár/könyvtár/src elérésen.