Komentáře PHP, Include/Include_once, Require/Require_once
Proč používat komentáře?
- Pokud na zdrojovém kódu nějakou dobu nepracujete, je snadné zapomenout, co kód dělá. Komentování zdrojového kódu pomáhá zapamatovat si, co kód dělá.
- Komentování zdrojového kódu je také velmi důležité, když na stejném projektu musí pracovat více vývojářů. Změny provedené jedním vývojářem mohou ostatní vývojáři snadno pochopit pouhým přečtením komentářů.
- Nejlepší je mít 3 řádky komentářů na každých 10 řádků kódu
Komentáře PHP
- Komentáře nám pomáhají porozumět kódu
- Komentáře jsou vysvětlení, která zařazujeme do našeho zdrojového kódu. Tyto komentáře jsou pro lidské porozumění.
- Jednořádkové komentáře začínají dvojitými lomítky // a končí na stejném řádku.
-
- Víceřádkové komentáře začínají lomítkem následovaným hvězdičkou /* a končí hvězdičkou následovanou lomítkem */.
-
Níže uvedený diagram ukazuje soubor PHP s víceřádkovými i jednořádkovými komentáři
Příklad PHP
PHP Include & PHP Include_once
Příkaz php „include“ se používá k zahrnutí dalších souborů do souboru PHP.
Má dvě varianty, include a include_once. Include_once je ignorován interpretem PHP, pokud má být soubor zahrnut.
Příkaz include má následující syntaxi
<?php include 'file_name'; ?>
Příkaz include_once má následující syntaxi
<?php include_once 'file_name'; ?>
TADY,
- „Include/include_once“ je příkaz, který zahrnuje soubor
- „'název_souboru'“ je název souboru, který má být zahrnut.
Příklad : Include / Include_once
Předpokládejme, že vyvíjíte web, který obsahuje stejnou navigační nabídku na všech stránkách.
Můžete vytvořit společnou hlavičku a poté ji zahrnout na každou stránku pomocí příkazu include Pojďme se podívat, jak to lze provést.
- Vytvoříme 2 názvy souborů
- header.php, index.php
Níže jsou uvedeny kódy pro; header.php
<a href="index.php">Home</a> <a href="aboutus.php">About us</a> <a href="services.php">Services</a> <a href="contactus.php">Contact Us</a>
index.php
<?php include 'header.php'; ?>
Zobrazí se výše uvedená záhlaví
PHP Require & PHP required_once
Příkaz require má dvě varianty, require a require_once.
Pro zahrnutí souboru se používá příkaz require/require_once.
Require_once se ignoruje, pokud byl požadovaný soubor již přidán některým ze čtyř příkazů include.
Má následující syntaxi
<?php require 'file_name'; ?>
<?php require_once 'file_name'; ?>
TADY,
- „require/require_once“ je příkaz, který obsahuje soubor
- „'název_souboru'“ je název souboru, který má být zahrnut.
Příklad: Vyžadovat
Předpokládejme, že vyvíjíme databázovou aplikaci.
Můžeme vytvořit konfigurační soubor, který můžeme zahrnout do všech stránek, které se připojují k databázi pomocí příkazu require. config.php
<?php $config['host'] = 'localhost'; $config['db'] = 'my_database'; $config['uid'] = 'root'; $config['password'] = ''; ?>
Podívejme se nyní na ukázkový kód, který vyžaduje konfigurační soubor. Stránky_model.php
<?php require 'config.php'; //require the config file //other code for connecting to the database ?>
PHP zahrnuje vs
Rozdíl mezi zahrnovat / vyžadovat
Zahrnout | Vyžadovat |
---|---|
Vydá varování, když dojde k chybě | Nevydává varování |
Provádění skriptu pokračuje, když dojde k chybě | Provádění skriptu se zastaví, když dojde k chybě. |
Obecně se doporučuje používat příkaz include, takže když dojde k chybě, spuštění skriptu bude nadále zobrazovat e-mailovou adresu webmastera nebo stránku kontaktujte nás.
Pokud celý skript nelze spustit bez požadovaného souboru, měl by se použít příkaz require.
Příkazy „include“ a „require“ lze použít na libovolném řádku ve zdrojovém kódu, kde chcete, aby se kód objevil.
Shrnutí
- Jediný HTML kód, jako jsou záhlaví, zápatí, postranní pruhy atd., lze sdílet na mnoha stránkách. To usnadňuje aktualizaci webu pouhou aktualizací jednoho souboru.
- PHP kód jako je nastavení konfigurace databáze, vlastní funkce atd. lze sdílet na mnoha stránkách, což zajišťuje, že web/aplikace používá stejná nastavení.
- Komentáře se používají k pochopení zdrojového kódu. Jsou pro lidské porozumění
- Jednořádkové komentáře začínají dvojitými lomítky //.
- Příkazy víceřádkového komentáře jsou uzavřeny mezi /* příkazy */.
- Pro zahrnutí souborů se používají příkazy „include, include_once, required a required_once“.
- Include_once/require_once se ignoruje, pokud byl požadovaný soubor již zahrnut pomocí kteréhokoli ze čtyř příkazů.
- Příkaz „zahrnout“ vydá varování a pokračuje v provádění, pokud požadovaný soubor nebyl nalezen.
- Příkaz require vyvolá závažnou chybu a zastaví provádění skriptu.
- Příkaz „include“ by měl být ve většině případů kromě situací, kdy bez požadovaného souboru, který má být zahrnut, nelze spustit celý skript.