str_contains() ב-PHP: בדיקה אם מחרוזת מכילה טקסט

str_contains($haystack, $needle) מחזירה true אם $needle מופיעה איפשהו ב-$haystack, ו-false אחרת. היא נוספה ב-PHP 8.0 והיא רגישה לרישיות.

<?php
$sentence = 'The quick brown fox';

var_dump(str_contains($sentence, 'quick'));   // true
var_dump(str_contains($sentence, 'Quick'));   // false: case-sensitive
var_dump(str_contains($sentence, 'dog'));     // false

if (str_contains($sentence, 'fox')) {
    echo "Found a fox\n";
}

בניגוד ל-strpos(), היא מחזירה בוליאני אמיתי, ולכן אין את המלכודת של "נמצא במיקום 0 נראה כמו false".

תחביר

str_contains(string $haystack, string $needle): bool
str_starts_with(string $haystack, string $needle): bool
str_ends_with(string $haystack, string $needle): bool

שלושתן נוספו ב-PHP 8.0 ועובדות בית אחר בית, ולכן הן מטפלות נכון ביפנית ובטקסט UTF-8 אחר בלי גרסת mb_.

בדיקת ההתחלה או הסוף עם str_starts_with ו-str_ends_with

<?php
$url = 'https://example.com/report.pdf';

var_dump(str_starts_with($url, 'https://'));   // true
var_dump(str_ends_with($url, '.pdf'));         // true
var_dump(str_ends_with($url, '.PDF'));         // false

$name = '株式会社コディ';
var_dump(str_starts_with($name, '株式会社'));   // true

בדיקת הכלה בלי תלות ברישיות

אין str_icontains(). המירו קודם את שתי המחרוזות לאותיות קטנות. mb_strtolower() ממירה לאותיות קטנות גם אותיות מחוץ ל-ASCII, כמו É או אותיות קיריליות, ש-strtolower() משאירה כמו שהן.

<?php
function containsIgnoreCase(string $haystack, string $needle): bool
{
    return str_contains(mb_strtolower($haystack), mb_strtolower($needle));
}

var_dump(containsIgnoreCase('Learning PHP', 'php'));       // true
var_dump(containsIgnoreCase('ÉCOLE DE CODE', 'école'));    // true

// The same check with stripos (ASCII letters only)
var_dump(stripos('Learning PHP', 'php') !== false);        // true

מחט ריקה מחזירה true

מחט ריקה נמצאת בכל מחרוזת, כולל במחרוזת ריקה. זה חשוב כשהמחט מגיעה מתיבת חיפוש שהמשתמש השאיר ריקה.

<?php
var_dump(str_contains('abc', ''));    // true
var_dump(str_contains('', ''));       // true

$search = '';   // a blank search field
$title = 'PHP str_contains';
$matches = $search !== '' && str_contains($title, $search);
var_dump($matches);

בדיקה אם מחרוזת מכילה אחת מכמה מילים או את כולן

str_contains() מקבלת מחט אחת. עברו בלולאה על מערך של מחטים: החזירו ברגע שאחת מתאימה בשביל "אחת מהן", או ברגע שאחת נכשלת בשביל "כולן".

<?php
function containsAny(string $haystack, array $needles): bool
{
    foreach ($needles as $needle) {
        if (str_contains($haystack, $needle)) {
            return true;
        }
    }
    return false;
}

function containsAll(string $haystack, array $needles): bool
{
    foreach ($needles as $needle) {
        if (!str_contains($haystack, $needle)) {
            return false;
        }
    }
    return true;
}

$comment = 'Buy cheap watches now';

var_dump(containsAny($comment, ['cheap', 'free', 'winner']));   // true
var_dump(containsAll($comment, ['cheap', 'free']));             // false

כדי לבדוק אם ערך הוא אחד האיברים של מערך, ולא תת מחרוזת של מחרוזת, השתמשו ב-in_array().

לפני PHP 8: strpos !== false

קוד שצריך לרוץ על PHP 7 משתמש ב-strpos() עם השוואה מחמירה. היא נותנת את אותה תשובה כמו str_contains(), חוץ ממחט ריקה: strpos() של PHP 7 הדפיסה Warning: strpos(): Empty needle והחזירה false.

<?php
$haystack = 'php is fun';

var_dump(str_contains($haystack, 'php'));       // PHP 8
var_dump(strpos($haystack, 'php') !== false);   // PHP 7 and later

// The bug to avoid: position 0 is falsy
var_dump((bool) strpos($haystack, 'php'));

השורה האחרונה מדפיסה bool(false) למרות שהטקסט שם, כי php יושב במיקום 0. החלפת בדיקות כאלה ב-str_contains() היא אחד השדרוגים הקלים ביותר ל-PHP 8.