CodeIgniter-kansio-, tiedosto- ja hakemistorakenne

Tiedostorakenteen ymmärtäminen CodeIgniter on välttämätön ennen minkään todellisen sovelluksen rakentamista. Ennakoitava asettelu auttaa sinua paikantamaan ohjaimet, mallit ja näkymät nopeasti, korjaamaan reititysongelmia ja perehdyttämään uusia tiimin jäseniä nopeammin. Tämä opetusohjelma kattaa klassisen CodeIgniter 3 -rakenne, jota käytetään edelleen laajalti, ja se selventää myös keskeisiä eroja, joita kohtaat CodeIgniter 4.x, joka esittelee app/-, public/- ja writable/-kansiot erillisinä ylimmän tason kansioina.

Mikä on CodeIgniterin tiedosto- ja hakemistorakenne?

CodeIgniter-tiedostorakenne on kansioiden ja PHP-tiedostojen oletusjärjestys, jonka kehys toimitetaan lataamisen tai asentamisen jälkeen. Se erottaa sovelluslogiikan kehyksen ytimestä, pitää composer-riippuvuudet erillään ja paljastaa yhden aloituspisteen index.php-tiedoston kautta. Seuraava kuva näyttää tiedostorakenteen CodeSytytin:

Tässä on yksinkertaistettu hakemistopuu tuoreelle CodeSytyttimen 3 asennus:

// CodeIgniter 3 root layout
project-root/
├── application/
├── system/
├── user_guide/
├── vendor/
├── composer.json
├── composer.lock
└── index.php

Ylimmän tason kansioiden selitys

Katsotaanpa nyt yllä olevia tiedostoja CodeSytyttimen rakenne:

• hakemus – tämä on hakemisto, joka sisältää sovelluslogiikkasi. Kaikki sovelluskoodisi sijaitsee tässä hakemistossa.
• järjestelmä – Tämä kansio sisältää kehyksen ydintiedostot. Ei ole suositeltavaa tehdä muutoksia tähän hakemistoon tai laittaa omaa sovelluskoodiasi tähän hakemistoon.
• käyttöohjeet – tämä hakemisto sisältää käyttöoppaan Codesytytin.
• myyjä – tämä hakemisto sisältää composer-pakettien lähdekoodia. Muut tähän hakemistoon liittyvät tiedostot ovat composer.json ja composer.lock.
• index.php – tämä on sovelluksen sisääntulokohta.

CodeIgniter-sovelluksen alihakemistot

Tarkastellaan nyt hakemistoja tarkemmin. Kuten mainittiin, sovellushakemisto sisältää projektikoodisi. Tässä osiossa tarkastelemme sovellushakemiston sisäisiä alihakemistoja. CodeSytyttimen hakemistorakenne:

• kätkö – tallentaa tuloste- ja tietokannan välimuistikirjastojen luomat välimuistissa olevat tiedostot.
• config – säilyttää määritystiedostot, kuten database.php, routes.php ja autoload.php.
• ohjaimet – kaikki sovellusohjaimet määritellään tässä ja ne on yhdistetty URL segmenteistä toimintoihin.
• ydin – sisältää mukautettuja ydinluokkia, jotka laajentavat järjestelmätiedostoja. Jos esimerkiksi luot perusohjaimen, jota muiden ohjainten tulisi laajentaa, sijoitat sen tähän hakemistoon.
• auttajia – tämä hakemisto CodeIgniter-kansiorakennetta käytetään käyttäjän määrittämiin apufunktioihin.
• koukut – käytetään CI-kansiorakenteen mukautetuille koukkuille, jotka käynnistyvät kehyksen suoritussyklin aikana.
• Kieli – käytetään kielitiedostojen tallentamiseen sovelluksille, jotka käyttävät useampaa kuin yhtä kieltä.
• kirjastot – käytetään mukautettujen kirjastojen tallentamiseen.
• lokit – sovelluksen lokitiedostot tallennetaan tähän hakemistoon.
• mallit – kaikki sovellusmallit tulee määritellä tähän hakemistoon.
• kolmas osapuoli – tätä käytetään sinun tai muiden kehittäjien luomiin mukautettuihin paketteihin.
• näkymät – sovellusnäkymät menevät tähän hakemistoon.

Tässä on esimerkki sovelluksen alihakemistopuusta:

// application/ subdirectories
application/
├── cache/
├── config/
├── controllers/
├── core/
├── helpers/
├── hooks/
├── language/
├── libraries/
├── logs/
├── models/
├── third_party/
└── views/

CodeSytytysjärjestelmän alihakemistot

Tarkastellaan nyt CI-tiedostorakenteen järjestelmän alihakemistoja. Muista, että kehyksen lähdekoodi sijaitsee täällä, joten älä tee mitään muutoksia tämän hakemiston tiedostoihin.

• ydin – Tämä on kuin sen sydän CodeIgniter-kehysKaikki kehyksen muodostavat ydintiedostot sijaitsevat täällä. Jos haluat laajentaa ydintiedoston toiminnallisuutta, sinun on luotava mukautettu ydintiedosto sovellushakemistoon. Sen jälkeen voit ohittaa tai lisätä uusia toimintoja haluamallasi tavalla. Älä koskaan tee muutoksia suoraan tänne.
• tietokanta – tietokannan ajurit, välimuisti ja muut tietokannan toimintoihin tarvittavat tiedostot löytyvät täältä.
• kirjasimet – Kuten nimestä voi päätellä, tämä hakemisto sisältää fontteja ja tietoa fonteista.
• auttajia – tässä hakemistossa CodeIgniter-rakennekansio sisältää valmiita apufunktioita.
• Kieli – sisältää kehyksen käyttämiä kielitiedostoja.
• kirjastot – sisältää lähdekooditiedostot eri kirjastoille, jotka tulevat mukana CodeSytytin laatikosta otettuna.

Järjestelmäkansion asettelu näyttää tältä:

// system/ subdirectories
system/
├── core/
├── database/
├── fonts/
├── helpers/
├── language/
└── libraries/

CodeIgniter user_guide -hakemisto

Tämä hakemisto toimii oppaana, kun haluat ymmärtää CodeIgniter-rajapinta. Tätä hakemistoa ei tule ladata, kun sovellusta otetaan käyttöön tuotantoympäristössä, koska se lisää kokoa ja paljastaa dokumentaatiota, jolla ei ole paikkaa live-palvelimella.

CodeSytyttimien toimittajahakemisto

Tämä hakemisto sisältää composerin kautta asennettavien pakettien lähdekooditiedostot. Hakemiston tiedostot tulee jättää sellaisiksi kuin ne ovat, eikä niihin tule tehdä muutoksia. Toisin kuin user_guide-hakemisto, tämä hakemisto tulee ladata, jos käytät sovelluksessasi composer-paketteja.

index.php-tiedosto

Index.php-tiedosto kohdassa CodeIgniter-tiedostorakenne sisältää käynnistyskoodin, joka määrittelee ympäristön, polut ja virheraportoinnin ennen ohjauksen luovuttamista frameworkille. Tämä tiedosto sijaitsee juurihakemistossa ja toimii etuohjaimena jokaiselle saapuvalle HTTP-pyynnölle.

Miten CodeIgniter 4 muuttaa rakennetta

CodeIgniter 4.x järjesti asettelun uudelleen parantaakseen turvallisuutta ja PSR-4:n automaattista latautumista. Yhden sovelluskansion sijaan näet nyt kolme ylimmän tason kansiota, jotka erottavat vastuualueet tarkemmin:

• sovellus/ – vastaa vanhempaa sovellusta/kansiota, joka sisältää ohjaimet, mallit, näkymät, kokoonpanot, suodattimet ja kirjastot.
• julkinen/ – ainoa verkossa näkyvä kansio, joka sisältää index.php-tiedoston sekä CSS-, JS- ja kuvasisältösi.
• kirjoitettava/ – tallentaa välimuistin, lokit, istunnot ja lataukset, jotka kehyksen on kirjoitettava suorituksen aikana.
• järjestelmä/ – sisältää edelleen viitekehyksen ytimen, nimitilaa asetellaan CodeSytytin\.
• myyjä / – composer-paketit, joiden rooli on identtinen CI 3:n kanssa.

// CodeIgniter 4 root layout
project-root/
├── app/
├── public/
├── writable/
├── system/
├── vendor/
├── tests/
├── composer.json
├── env
└── spark

Jos aloitat tänään uuden projektin, CodeIgniter 4 on suositeltu versio. Jos ylläpidät vanhempaa koodikantaa, yllä kuvattu CI 3 -rakenne vastaa levyllä näkyvää rakennetta.

Työskentely CodeSytyttimen rakenne päivittäin

Kun tiedät, missä kukin kansio sijaitsee, yleisistä tehtävistä tulee suoraviivaisia. Luo uusi ohjain kansioon application/controllers/ (tai app/Controllers/ CI 4:ssä), yhdistä se reittiin config/routes.php-tiedostossa, rakenna malli kansioon models/ ja renderöi näkymätiedoston tuloste kansioon views/. Pidä kokoonpano kansioon config/, pudota uudelleenkäytettävää koodia apuohjelmiin/ tai kirjastoihin/ ja anna composerin hallita kaikkea vendor/-kansion sisällä. Pidä kiinni tästä kurinalaisuudesta, niin projektisi on helppo navigoida myös sen kasvaessa.

UKK