雑多なレビューサイトこもれびゅー備忘録を兼ね PC周辺機器・家電製品・文房具等々の製品レビューを行っているサイトです

• ホーム
• プログラミング
• PHP

共通コンテンツ（コード）を外部ファイル化し、読み込み利用する平成30年 1月 9日 作成

概略

HTML・PHPを作成しページが増えて行くとヘッダー部・フッター部といった共通利用部分の作成において、作成するだけならコピペ操作で容易なのだが、修正となるとページ毎に修正を加えなくてはならなくなり大変。

そこで、ヘッダー、フッターといった共通利用部分を外部ファイル化し、利便性・メンテナンス性向上を図る。

手段

共通部分のソースコードを別のPHPファイルとして保存する。

呼び出し元のファイルに読み出し用の関数を記載する。

上記2工程で当初の目的は達成できるが、読み出し方法には複数あり用途が異なるので、詳細を下記に記載。

実装方法

読み込み方法・使用する関数

• include読み込みに失敗した場合、後にづつく処理も続行する。
• require読み込みに失敗した場合、後にづつく処理は停止する。
• include_once同ファイルが指定された場合、一度だけ読み込む。読み込みに失敗した場合、後にづつく処理も続行する。
• require_once同ファイルが指定された場合、一度だけ読み込む。読み込みに失敗した場合、後にづつく処理は停止する。

呼び出し元のファイルへの記述方法。

「include」記述例

<?php
	include("sample.php");
?>

「require」記述例

<?php
	require("sample.php");
?>

「include_once」記述例

<?php
	include_once("sample.php");
?>

「require_once」記述例

<?php
	require_once("sample.php");
?>

呼び出されるファイル「sample.php」。

<h1>メインタイトル</h1>
<!-- コンテンツ -->

上記「include」・「require」関数には相対パス・絶対パスが使える。

下記の様なディレクトリ構造時で「second.php」 から「header.php」インクルードする場合。

• index.php
• common
  • module
    • header.php
    • footer.php
• about
  • second.php

絶対パス例

<?php
	// ドキュメントルートと組み合わせて使う
	$root = $_SERVER['DOCUMENT_ROOT'];
	include($root."/common/module/header.php");
?>

相対パス例

<?php
	// 「__DIR__」を使用し「include」・「require」を記述するファイルからの相対パスで指定
	include(__DIR__."/../common/module/header.php");
?>

考察

作成したHTML・PHPファイルの共通部分の外部ファイル化による利便性・メンテナンス性向上した。

通常ファイル等の読み込みは「include()」、確実に読み込ませなくてはならない重要場面等においては「require()」と、使い分けが必要なのかな。 読み込み指定を間違わないことが一番。

多くのページで対象ファイルを読み込み場合においては、修正を行う場合、そのファイルのみの修正で全ファイルの修正が可能となり、利便性・メンテナンス性が向上した。

コメント