HOME>WEBプログラム覚書>[PHP]ウェブデザイナーはどんな関数をつくればよいか。

[PHP]ウェブデザイナーはどんな関数をつくればよいか。

PHPを学び始めて関数の作り方はわかったけど、どういう関数作ればいいのかよくわからんって人に。 HTMLを記述する人(クライアント)向けにどんな関数を作ればよいのか考えていきます。

WordPressのプラグインとかテンプレートタグ作る場合も役立つと思います。

ダメ絶対ダメ。

まずは後々死にたくなる関数とその利用パターン。

my_function.php

<?php
display_books()
{
$books = array(
'php' => array(
'title' => 'PHPでサイト制作',
'price' => '2000',
),
'javascript' => array(
'title' => 'サーバーサイドJavascript',
'price' => '4000',
),
'actionscript' => array(
'title' => 'Actionscript3.0 Tips',
'price' => '2500',
),
);
echo '<table>';
foreach ($books as $key => $value) {
echo '<tr>';
echo '<th>' . $value['title'] . '</th>';
echo '<td>' . $value['price'] . '</td>';
echo '</tr>';
}
echo '<table>';
}
?>

index.php

<div class="myBooks">
<?php display_books(); ?>
</div>

こういう関数を利用してサイト作っちゃうと高確率で死ねます。

で、何が問題なのか？

display_books()が「データの保持」と「出力」の両方をやってしまっている点です。これでは本のデータを他で利用したいと思ったとき、利用することが出来ません。

なので「データの保持」と「出力」を分離します。

my_function.php

<?php
get_books()
{
$data = array(
'php' => array(
'title' => 'PHPでサイト制作',
'price' => '2000',
),
'javascript' => array(
'title' => 'サーバーサイドJavascript',
'price' => '4000',
),
'actionscript' => array(
'title' => 'Actionscript3.0 Tips',
'price' => '2500',
),
);
return $data;
}
display_books()
{
$books = getBooks();
echo '<table>';
foreach ($books as $key => $value) {
echo '<tr>';
echo '<th>' . $value['title'] . '</th>';
echo '<td>' . $value['price'] . '</td>';
echo '</tr>';
}
echo '<table>';
}
?>

とりあえずこれで本のデータを何処からでも取得できるようになりました。

では、次なる問題点はなんでしょう？

そのHTMLが最終形態だと思ってはいけない

そうです。フリーザ様同様にマークアップも変身していくのです。

にも関わらず、display_books()は関数内でHTMLを出力しちゃってます。これでは次の処理につなげられません。どういうことかというと、こんなことができなくなります。

PHP

<?php
div_wrap($html) {
return '<div class="styleX">' . $html . '</div>';
}
echo div_wrap(display_books());
?>

HTMLのマークアップは多様です。関数が返したものをさらに加工したい場合も多々あるのです。なので「いつ出力するか」は最終形態を知るクライアントが決めればよいのです。

バッファリングという手もありますが、そんなの毎回するのは非効率的です。なので関数内で生成したHTMLは出力ではなく、必ず返すようにしたほうがよいでしょう。

では、display_books()から出力の機能を取り外してみましょう。

my_function.php

<?php
get_books()
{
$data = array(
'php' => array(
'title' => 'PHPでサイト制作',
'price' => '2000',
),
'javascript' => array(
'title' => 'サーバーサイドJavascript',
'price' => '4000',
),
'actionscript' => array(
'title' => 'Actionscript3.0 Tips',
'price' => '2500',
),
);
return $data;
}
get_books_table()
{
$books = getBooks();
$html = '';
$html .= '<table>';
foreach ($books as $key => $value) {
$html .= '<tr>';
$html .= '<th>' . $value['title'] . '</th>';
$html .= '<td>' . $value['price'] . '</td>';
$html .= '</tr>';
}
$html .= '<table>';
return $html;
}
div_wrap($html) {
return '<div class="styleX">' . $html . '</div>';
}
?>

index.php

echo div_wrap(get_books_table());

で次なる問題点。

WordPressの関数を全て覚えてますか？

get_books_table()が、「本のリストをテーブルマークアップする」という用途にしか使えません。まぁそれはそれで間違いではないのですが、難癖つけていきましょう。

get_books_table()のような関数はなぜ問題なのか？

繰り返し書いているようにHTMLのマークアップが多様だからです。 tableではなく、ulやdlでマークアップしたい場合、このままではget_books_ul()やget_books_dl()を作ることになるでしょう。

またデータの種類も大抵増えていくものです。例えばゲームソフトを扱う場合、get_games_table()、get_games_ul()とget_games_dl()を作らなくてはなりません。

このように要求が増えるたびに、関数も増えていってしまうのです。当然関数が増えると同じ関数名は使えませんから、長くなってしまったり、似たような名前になってしまったり、宇宙の法則がみだれてget_books_dl()であるべきところをget_dl_books()としてしまったり。

WordPressの関数を全て覚えてますか？はい。と答えれるような頭脳をもった人に、僕から言えることなんて何もありません。自分の好きなようにやっても問題は起こらないでしょう。自分の道を邁進していただきたい。

それ以外の人は、自分でも何のために作ったのか、使ってるのか使ってないのか分からない関数を生み出す可能性大です。関数作成のスキルを身につけた人が大抵通る道ですから。

なぜ、get_books_table()の用途が限られているのか

ではなぜ、get_books_table()の用途が限られているのでしょうか？それは「何を(本を)」と「どのような形式で(テーブル形式で)」の2つのを処理してしまっているからです。

そもそも「何を」と「どういう形式で」使うのかはクライアントの頭の中です。なので「何を」と「どういう形式で」をクライアントが使用するときに選択するというのが自然です。

全てのパターン満たす関数を用意したって、クライアントも自分の要求を満たす関数を膨大な関数の中から探すのは大変なのです。

ということでそこら辺を分けていきます。

html.php

<?php
function table(Array $data)
{
$html = '';
$html .= '<table>';
foreach ($data as $key => $value) {
$html .= '<tr>';
$html .= '<th>' . $value['title'] . '</th>';
$html .= '<td>' . $value['price'] . '</td>';
$html .= '</tr>';
}
$html .= '<table>';
return $html;
}
function ul(Array $data)
{
$html = '';
$html .= '<ul>';
foreach ($data as $key => $value) {
$html .= '<th>' . $value['title'] . $value['price'] . '</th>';
}
$html .= '<ul>';
return $html;
}
function dl(Array $data)
{
$html = '';
$html .= '<dl>';
foreach ($data as $key => $value) {
$html .= '<dt>' . $value['title'] . '</dt>';
$html .= '<dd>' . $value['price'] . '</dd>';
}
$html .= '<dl>';
return $html;
}
?>

resource.php

<?php
get_books()
{
$data = array(
'php' => array(
'title' => 'PHPでサイト制作',
'price' => '2000',
),
'javascript' => array(
'title' => 'サーバーサイドJavascript',
'price' => '4000',
),
'actionscript' => array(
'title' => 'Actionscript3.0 Tips',
'price' => '2500',
),
);
return $data;
}
?>

my_function.php

<?php
div_wrap($html) {
return '<div class="styleX">' . $html . '</div>';
}
?>

index.php

<?php
echo div_wrap(table(get_books()));
echo div_wrap(ul(get_books()));
?>

クライアントが多少見にくくなったかもしれませんが、ゲームというデータが増えた場合も下記のようにデータを取得する関数を追加するだけで済むようになりました。

resource.phpに追加

<?php
get_games()
{
$data = array(
'wii' => array(
'title' => 'うぃ',
'price' => '2000',
),
'nintendo 3ds' => array(
'title' => 'ニンテンドー3DS',
'price' => '25000',
),
'wii U' => array(
'title' => 'うぃー U',
'price' => '30000',
),
);
return $data;
}
?>

index.php

<?php
echo div_wrap(table(get_books()));
echo div_wrap(ul(get_books()));
echo div_wrap(table(get_games()));
echo div_wrap(ul(get_games()));
?>

ここでdiv_wrap(table(get_books()))を頻繁に使うようであれば、 my_function.phpも寂しくなったことだしbook用の関数を作りましょう。

my_function.php

<?php
books_for_html()
{
return div_wrap(table(get_books()));
}
?>

で、あまり使わなそうなものは直接コーディングしてしまいましょう。

index.php

<div class="myFavaritGames">
<table class="styleX">
<?php
$html = "";
foreach (get_games() as $key => $value) {
$html .= sprintf('
<tr class="%s">
<th class="styleY">%s</th>
<td><img src="icon.gif">%s</td>
</tr>
',
$key,
$value['title'],
$value['price']
);
}
echo $html;
?>
</table>
</div>

ここら辺のコーディングの話と直接コーディングした場合の問題については、レッドブルプラシーボ効果も切れたのでまた今度書きたいと思います。

とりあえず現在のイメージ。

関数の名前

触れ忘れてましたが、関数の名前も重要です。最初に登場したdisplay_books()は良くない名前です。これを記述するindex.phpでは、プレビューするか関数の中を覗かないと何が出力されるかわからないからです。

特にDreamweaver(最近どうなんだろ？)などのエディタでは、IDEのように関数にジャンプすることができません。なので、どのようなHTMLが出力されるのか「つかみ」ができるような関数名が望ましいです。

何気にbooks_for_html()もよくないですねｗいやー命名ってムズイですね。

まとめ

とりあえず、

関数内で出力しない
なんでもかんでも関数をつくろうとしない

に気をつけておくと、使い勝手のよい関数になるんじゃないのかなと思います。

投稿日	2011年6月10日 03:34
カテゴリ	PHP
タグ	WordPress \| 関数
トラックバック URL	http://www.kantenna.com/cgi-bin/mt504/mt-tb.cgi/1225

コメントする

Name

Email Address

URL

コメント(スタイル用のHTMLタグを使えます)

ログイン情報を記憶

[PHP]ウェブデザイナーはどんな関数をつくればよいか。

ダメ絶対ダメ。

my_function.php

index.php

my_function.php

そのHTMLが最終形態だと思ってはいけない

PHP

my_function.php

index.php

WordPressの関数を全て覚えてますか？

get_books_table()のような関数はなぜ問題なのか？

なぜ、get_books_table()の用途が限られているのか

html.php

resource.php

my_function.php

index.php

resource.phpに追加

index.php

my_function.php

index.php

関数の名前

まとめ

コメント

コメントする

KANTENNA.COM

プログラム

カテゴリ

Memo

プログラムの原則

jQuery不要のアニメーションスクロールライブラリAOS

Error 1449 The user specified as a definer (‘username’@’hostname’) does not exist

Invalid default value for カラム名

14: curl#6 – “Could not resolve host: mirrors.iuscommunity.org; 不明なエラー”

[PHP]ウェブデザイナーはどんな関数をつくればよいか。

ダメ絶対ダメ。

my_function.php

index.php

my_function.php

そのHTMLが最終形態だと思ってはいけない

PHP

my_function.php

index.php

WordPressの関数を全て覚えてますか？

get_books_table()のような関数はなぜ問題なのか？

なぜ、get_books_table()の用途が限られているのか

html.php

resource.php

my_function.php

index.php

resource.phpに追加

index.php

my_function.php

index.php

関数の名前

まとめ

コメント

コメントする

プログラム

カテゴリ

Memo

プログラムの原則

jQuery不要のアニメーションスクロールライブラリAOS

Error 1449 The user specified as a definer (‘username’@’hostname’) does not exist

Invalid default value for カラム名

14: curl#6 – “Could not resolve host: mirrors.iuscommunity.org; 不明なエラー”

PAGE RANK

TIME LINE

Tag