CodeIgniter Mappe-, Fil- og Katalogstruktur

Forståelse af filstrukturen i CodeIgniter er afgørende, før du bygger en rigtig applikation. Et forudsigeligt layout hjælper dig med hurtigt at finde controllere, modeller og visninger, fejlfinde routingproblemer og onboarde nye teammedlemmer hurtigere. Denne vejledning dækker den klassiske CodeIgniter 3-struktur, der stadig er bredt anvendt, og som også tydeliggør de vigtigste forskelle, du vil støde på i CodeIgniter 4.x, som introducerer app/, public/ og writable/ som separate mapper på topniveau.

Hvad er CodeIgniter fil- og mappestruktur?

CodeIgniter-filstrukturen er standardarrangementet af mapper og PHP-filer, som frameworket leveres med, efter du har downloadet eller installeret det. Den adskiller din applikationslogik fra framework-kernen, holder composer-afhængigheder isolerede og eksponerer et enkelt indgangspunkt via index.php. Følgende billede viser filstrukturen i CodeTændingsapparat:

Her er et forenklet katalogtræ til en frisk CodeInstallation af Igniter 3:

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

Forklaring af mapper på øverste niveau

Lad os nu se på ovenstående filer i CodeTændingsstruktur:

• ansøgning – dette er den mappe, der indeholder din applikationslogik. Al din applikationskode vil være indeholdt i denne mappe.
• systemet – denne mappe indeholder ramme-kernefilerne. Det frarådes at foretage ændringer i denne mappe eller indsætte din egen applikationskode i denne mappe.
• brugervejledning – denne mappe indeholder brugervejledningen til Codetændsats.
• sælger – denne mappe indeholder kildekoden til composer-pakkerne. De andre filer relateret til denne mappe er composer.json og composer.lock.
• index.php – dette er indgangspunktet i ansøgningen.

CodeUndermapper til Igniter-applikationen

Lad os nu se nærmere på mapperne. Som nævnt indeholder applikationsmappen din projektkode. I dette afsnit vil vi se på de interne undermapper i CodeIgniter-mappestruktur:

• cache – gemmer cachelagrede filer genereret af output- og databasecachebibliotekerne.
• config – gemmer konfigurationsfiler såsom database.php, routes.php og autoload.php.
• controllere – alle applikationscontrollere er defineret her og kortlagt URL segmenter til handlinger.
• kerne – indeholder brugerdefinerede kerneklasser, der udvider systemfiler. Hvis du for eksempel opretter en basiscontroller, som andre controllere skal udvide, skal du placere den i denne mappe.
• hjælpere – denne fortegnelse over CodeIgniter-mappestrukturen bruges til brugerdefinerede hjælpefunktioner.
• kroge – bruges til brugerdefinerede hooks i CI-mappestrukturen, der aktiveres under framework-udførelsescyklussen.
• Sprog – bruges til at gemme sprogfiler til applikationer, der bruger mere end ét sprog.
• biblioteker – bruges til at gemme brugerdefinerede biblioteker.
• logs – applikationslogfiler gemmes i denne mappe.
• modeller – alle applikationsmodeller skal defineres i denne mappe.
• tredje part – dette bruges til brugerdefinerede pakker, som du eller andre udviklere har oprettet.
• visninger – applikationsvisninger placeres i denne mappe.

Her er et eksempel på programmets undermappetræ:

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

CodeUndermapper til tændingssystem

Lad os nu se på systemundermapper i CI-filstrukturen. Husk, at det er her, frameworkets kildekode findes, så foretag ikke ændringer i filerne i denne mappe.

• kerne – dette er ligesom hjertet af CodeIgniter FrameworkAlle kernefilerne, der udgør frameworket, er placeret her. Hvis du vil udvide funktionaliteten af ​​kernefilen, skal du oprette en brugerdefineret kernefil i programmappen. Derefter kan du tilsidesætte eller tilføje ny adfærd, som du ønsker. Du bør aldrig foretage ændringer direkte her.
• database – databasedrivere, cache og andre filer, der er nødvendige for databaseoperationer, findes her.
• skrifttyper – som navnet antyder, indeholder denne mappe skrifttyper og information om skrifttyper.
• hjælpere – denne mappe i CodeIgniter-strukturmappen indeholder hjælpefunktioner, der følger med ud af æsken.
• Sprog – indeholder sprogfiler, der bruges af frameworket.
• biblioteker – indeholder kildefilerne til de forskellige biblioteker, der følger med CodeTænderen er taget ud af kassen.

Systemmappens layout ser sådan ud:

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

CodeIgniter brugervejledning Katalog

Denne oversigt fungerer som en referencevejledning, når du ønsker at forstå CodeIgniter API. Du bør ikke uploade denne mappe, når du implementerer din applikation i produktion, da den øger størrelsen og afslører dokumentation, der ikke hører hjemme på en liveserver.

CodeIgniter-leverandørkatalog

Denne mappe indeholder kildefiler til pakker, som du installerer via composer. Filerne i denne mappe skal forblive, som de er, og der må ikke foretages ændringer i dem. I modsætning til user_guide-mappen skal denne mappe uploades, hvis du bruger composer-pakker i din applikation.

index.php-fil

Index.php-filen i CodeIgniter-filstrukturen indeholder bootstrap-koden, der definerer miljø, stier og fejlrapportering, før kontrollen overføres til frameworket. Denne fil er placeret i rodmappen og fungerer som frontcontroller for alle indgående HTTP-anmodninger.

Hvordan CodeIgniter 4 ændrer strukturen

CodeIgniter 4.x har reorganiseret layoutet for at forbedre sikkerheden og automatisk indlæsning af PSR-4. I stedet for en enkelt programmappe ser du nu tre mapper på øverste niveau, der adskiller bekymringerne mere præcist:

• app / – svarende til den ældre applikation/mappe, der indeholder controllere, modeller, visninger, konfiguration, filtre og biblioteker.
• offentlig/ – den eneste web-eksponerede mappe, der indeholder index.php og dine CSS-, JS- og billedelementer.
• skrivbar/ – gemmer cache, logfiler, sessioner og uploads, som frameworket skal skrive under kørsel.
• system/ – indeholder stadig kernen i frameworket, navneafstanden er under CodeTændingsapparat\.
• sælger / – komponistpakker, identiske i rolle som CI 3.

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

Hvis du starter et nyt projekt i dag, CodeIgniter 4 er den anbefalede version. Hvis du vedligeholder en ældre kodebase, vil CI 3-strukturen beskrevet ovenfor matche det, du ser på disken.

Arbejder med CodeTændingsstruktur Dag til dag

Når du ved, hvor hver mappe er placeret, bliver almindelige opgaver ligetil. Opret en ny controller under application/controllers/ (eller app/Controllers/ i CI 4), match den med en rute i config/routes.php, byg en model under models/, og render output fra en view-fil i views/. Behold konfigurationen i config/, slip genanvendelig kode i helpers/ eller libraries/, og lad composer administrere alt inde i vendor/. Hold dig til denne disciplin, og dit projekt vil forblive let at navigere i, selvom det vokser.

Ofte Stillede Spørgsmål