الدالة ob_end_clean()‎ في PHP

من موسوعة حسوب
< PHP
مراجعة 12:33، 29 مايو 2018 بواسطة رؤيا-بنعطية (نقاش | مساهمات) (تعديلات طفيفة على التنسيق)

(PHP 4, PHP 5, PHP 7)

تنظف (تمسح) الدالة ob_end_clean()‎ المخزنَ المؤقت للإخراج وتوقف التخزين المؤقت للإخراج.

الوصف

bool ob_end_clean ( void )

ستؤدي الدالة ob_end_clean()‎ إلى حذف محتويات المخزن المؤقت للإخراج ذي أعلى مستوى (topmost) إضافةً إلى إغلاقه. إذا كنت تريد معالجة محتويات المخزن المؤقت فعليك استدعاء الدالة ob_get_contents()‎ قبل الدالة ob_end_clean()‎ ذلك لأنه ستُحذف محتويات المخزن المؤقت عند استدعاء الدالة ob_end_clean()‎.

يجب بدء تشغيل المخزن المؤقت للإخراج بواسطة الدالة ob_start()‎ مع الرايتين  PHP_OUTPUT_HANDLER_CLEANABLE وPHP_OUTPUT_HANDLER_REMOVABLE. وإلا فلن تعمل الدالة ob_end_clean()‎.

القيم المعادة

تُعيد الدالة ob_end_clean()‎ القيمة  TRUE في حالة النجاح أو القيمة FALSE عند الفشل.

قد تفشل هذه الدالة بسبب استدعائها دون وجود مخزن مؤقت نشط، أو لأنها لم تستطع مسح المخزن المؤقت (وذلك ممكنٌ في حال كان المخزن المؤقت خاصًا).

الأخطاء والاستثناءات

سيولّد تنبيهٌ من النوع E_NOTICE إذا فشل تنفيذ الدالة ob_end_clean()‎.

أمثلة

يوضح المثال التالي طريقةً سهلةً للتخلص من كافة المخازن المؤقتة للإخراج:

المثال 1: مثال على الدالة ob_end_clean()‎

<?php
ob_start();
echo 'Text that won\'t get displayed.';
ob_end_clean();
?>

انظر أيضًا

  • الدالة ob_start()‎: تشغيل التخزين المؤقت للإخراج.
  • الدالة ob_get_contents()‎: إعادة محتويات المخزن المؤقت للإخراج.
  • الدالة ob_flush()‎: تدفق (إرسال) المخزن المؤقت للإخراج.

مصادر