return false; がエラーになってしまう

Question

実現したいこと

ソースコードに return false; を入れたい

前提

ソースコードのほかの機能は全部きちんと動いてる

発生している問題・エラーメッセージ

エラーはでない、return false; の false の部分に波線がでる。

どこにエラーが、隠れているのかわからない。

該当のソースコード

<?php

ini_set('display_erros',true);
require_once '../dbconnect.php';

class UserLogic
{
    /**
     * ユーザーを登録する
     * @param array $userData
     * @return bool $result
     */
    public static function createUser( $userData )
    {
        $result = false;
        $sql = 'INSERT INTO users( name, email, password )
        VALUES ( ?, ?, ? )';

        //  ユーザデータを配列に入れる
        $arr = [];
        $arr[] = $userData['username'];
        $arr[] = $userData['email'];
        $arr[] = password_hash( $userData['password'], PASSWORD_DEFAULT );

        try {
            $stmt = connect()->prepare( $sql );
            $result = $stmt->execute( $arr );
        } catch (\Exception $e){
            echo $e->getMessage();
            return $result;
        }



        return $result;
    }







    /**
     * ログイン処理
     * @param string $email
     * @param string $password
     * @return bool $result
     */
    public static function login( $email, $password )
    {
        //  結果
        $result = false;
        //  ユーザーをemailから検索して取得
        $user = self::getUserByEmail( $email );

        if( !$user )
        {
            $_SESSION['msg'] = 'emailが一致しません。';
            return $result; // false;
        }

        //  パスワードの照会
        if( password_verify( $password, $user['password'] ) )
        {
            //  ログイン成功
            session_regenerate_id(true); // セッションハイジャック対策
            $_SESSION['login_user'] = $user;
            $result = true;
            return $result;
        }

        $_SESSION['msg'] = 'パスワードが一致しません。';
        return $result; // false;
    }






    /**
     * emailからユーザーを取得
     * @param string $email
     * @return array bool $user | false
     */
    public static function getUserByEmail( $email )
    {
        //  SQLの準備
        $sql = 'SELECT * FROM users WHERE email = ?';

        //  email を配列に入れる
        $arr = [];
        $arr[] = $email;

        //  SQLの実行
        try {
            $stmt = connect()->prepare( $sql );
            $stmt->execute( $arr );
            //  SQLの結果を返す
            $user = $stmt->fetch();
            return $user;
        } catch (\Exception $e){
            echo $e->getMessage();
            return false; // << false がいけない？

            $user = false;
            return $user; // << これも $user がいけない
        }
    }

}

試したこと

$user = false; として、
return $user; としたが、これも波線がでる。

補足情報（FW/ツールのバージョンなど）

OS:Windows10
ブラウザ：クローム
エディタ：VS Code

Comments

[maisumakun]

出た波線にマウスを重ねると詳細が出てきませんか？

[yukkuri_55]

マウスを重ねると
Return value of getUserByEmail() is expected to be of type array, bool returned
const bool false
とでたので、

/**
* emailからユーザーを取得
* @param string $email
* @return array bool $user | false
*/

を

/**
* emailからユーザーを取得
* @param string $email
*/

に変更したら 波線はでなくなりました。

[yukkuri_55]

ベストアンサーに選びたいので、レスを返していただけないでしょうか？

Answer 1

@return array bool $user | false

この記述はPHPDocのreturnのデータ型を記述する書式として正しくありません。

@return <データ型> <コメント> が書式になるため、arrayがデータ型、bool $user | false がコメントとして解釈されています。

取得したuserの配列、失敗時はfalseを返すという設計なのであれば下記のような書式になります。

@return array|false <コメント>

https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/return.html#return

Comments

[yukkuri_55]

勉強になりました。
/**
* emailからユーザーを取得
* @param string $email
* @return array bool $user | false
*/
を
/**
* emailからユーザーを取得
* @param string $email
* @return array|false
*/
に変更したら、期待どおりになりました。
解決しました。ありがとうございました。

Answer 2

false でリターンする、ということは、その関数の戻り値の型は論理型となります。
が、別のところでreturn $user となってますが、この$userと言うのは論理型なんでしょうか

Comments

[yukkuri_55]

$user は SQLの実行結果 配列(array)を返すと思います。
でも、失敗すると false を返したいのですが、まずいでしょうか？
PHPは初心者レベルなので、すいません。
動画を参考にしながら勉強しているのです。
他の手段があるでしょうか？