PHPの関数でreturnさせるときに、値を追加していく方法

Question

###実現したいこと
お世話になります。PHP初心者です。

PHPの条件分岐で<p>値</p>を出力するとき、

いずれの分岐先でも<div class="animal"></div>を追加して、<p>値</p>を囲みたいです。

###ためしたコード
イメージとしてはこうです。

function get_animal( $animal ){
    
    return '<div class="animal">';
    
    if ( $animal == 'dog' ) {
    	return += '<p>犬です。</p>';
    }elseif ( $animal == 'cat' ) {
    	return += '<p>猫です。</p>';
    }
    
    return += '</div>';

}

仮に上の関数でecho get_animal( 'dog' );した場合に、下記の出力を実現させたいわけなんですが、このようなケースでは上のPHPはどのように書くべきなのでしょうか？

<div class="animal">
<p>犬です。</p>
</div>

Answer 1

ケースバイケースではありますが、今回の例を見る限りでは

<?php

// HTMLエスケープ用関数（今回の文字列では問題ないが基本的に一貫して使うべき）
function h($s)
{
    return htmlspecialchars($s, ENT_QUOTES, 'UTF-8');
}

// 動物のキーから日本語名を取得する関数（定義が無ければ「？」）
function get_animal($animal)
{
    static $animapMap = [
        'dog' => '犬',
        'cat' => '猫',
    ];
    return $animalMap[$animal] ?? '？';
}

として上の方またはHTMLを出す部分とは別のファイルで関数を定義し、HTML出力部分では

<div class="animal">
    <p><?=h(get_animal($animal))?>です</p>
</div>

と書くのが正解だと思います。基本的には関数でHTMLをリターンするのは避けたほうがいい設計ですね。
ちなみに <?= ... ?> は <?php echo ... ?> のシンタックスシュガーです。

そして、もしこの塊を再利用できるようにしたいのであれば、関数ではなくテンプレートファイルとして置くほうがいいと思います。例えば

<?php

// テンプレートファイルパス（の一部）とそれで使われている変数を渡してレンダリングする関数
function template($template, array $variables = [])
{
    (function () {
        extract(func_get_arg(1));
        include(__DIR__ . '/templates/' . func_get_arg(0) . '.php');
    })($template, $variables);
}

をどこかに定義しておき、HTML生成部分で

<?php template('animal', ['animal' => 'dog']) ?>
<?php template('animal', ['animal' => 'cat']) ?>

のように呼び出すイメージです。実際、Laravelなどのメジャーなフレームワークにも似たような設計が取り入れられています。

Comments

[gankonako]

詳しくありがとうございました。それにHTMLエスケープ用関数は便利ですね。これから使うように心がけたいと思います。

Answer 2

returnするとその場で処理が終わってしまうので、
処理に応じて変数に文字列を組み立てて最後にreturnする前に共通の文字列を連結してあげてください。

イメージとしては以下のような感じ

function wrapText($text){

  if($text === "a"){
    $wrappedText = "given text is A"; 
  }else{
    $wrappedText = "given text is ".$text;
  }

  return "<p>".$wrappedText."</p>";

}

Comments

[gankonako]

あなるほど、条件の中は「return」でなく「returnさせたい値を変数に入れる」んですね。ありがとうございます。

Answer 3

mpywさんのがベストだと思いますが、
テンプレートが面倒ならこんなのも…

<?php

//ここも連想配列使えるならその方がいいです。
function get_animal($animal) {
    switch ($animal) {
    case 'dog': $ret = '犬';break;
    case 'cat': $ret = '猫';break;
    default :   $ret = '?';
    }
    return $ret;
}

//HTMLの一部をを出力する
function put_part($str) {
?>
<div class="animal">
<p><?=$str?>です。</p>
</div>
<?php
}

//HTML表示部分

put_part(get_animal($animal));

?>

Comments

[mpyw]

関数の中で ?> で閉じて最後に <? で再開するのは WordPress などでも見るやつですね！（一番良い書き方とは言えないけど…）

[gankonako]

switchとcaseという使い方を初めてみました。ありがとうございます。勉強になりました！

Answer 4

本来どう書くべきかというのはさておき、元のプログラムの間違いを正すと、

function get_animal( $animal ){

    $r = '<div class="animal">';

    if ( $animal == 'dog' ) {
        $r .= '<p>犬です。</p>';
    }elseif ( $animal == 'cat' ) {
        $r .= '<p>猫です。</p>';
    }

    $r .= '</div>';
    return $r;
}

Comments

[gankonako]

なるほどプラスではなくドットでしたか。ありがとうございます。