عرض مصدر PHP/addcslashes

<noinclude>{{DISPLAYTITLE:الدالة <code>addcslashes()‎</code> في PHP}}</noinclude>
تضيف الدالة <code>addcslashes()‎‎</code> الخطوط المائلة العكسية (backslashes) كما في لغة C.

== الوصف ==
<syntaxhighlight lang="php">
string addcslashes ( string $str , string $charlist )
</syntaxhighlight>

تُعيد الدالة سلسلةً نصيةً تسبقها خطوط مائلة عكسية (backslashes) قبل المحارف الموجودة في المعامل charlist.

== المعاملات ==

=== str ===
تحتوي السلسلة النصية المُرَاد إضافة الخطوط المائلة العكسية لها.

=== charlist ===
تحتوي المحارف التي ستُضاف الخطوط المائلة العكسية عندها. فإذا احتوى المعامل <code>charlist</code> على أحرف على شكل <code>n\</code> أو <code>‎\r</code> وما إلى ذلك من القيم فستتعامل هذه الدالة معها بنمط لغة C، أما العناصر الأخرى غير الأبجدية أو الرقمية والتي لها رمز ASCII أقل من 32 وأعلى من 126 فستُحَول إلى التمثيل الثُماني للتعامل معها.

عند تعريف مجال من المحارف عند ضبط قيمة المعامل <code>charlist</code>، فاحرص على معرفة كل القيم والأحرف الموجودة بين حديّ بداية ونهاية ذاك المجال.<syntaxhighlight lang="php">
<?php
echo addcslashes('foo[ ]', 'A..z');
//"\f\o\o\[ \]"
// ستُهرِّب جميع المحارف، سواءً كانت كبيرةً أم صغيرة
// بما في ذلك المحارف الآتية:
// [\]^_`
?>


</syntaxhighlight>

إذا كانت قيمة رمز ASCII لأوّل محرف في المجال أعلى من قيمة رمز ASCII للمحرف الثاني في المجال،  فلن يُنشَأ أي مجال، بل سيُستَخدم محرف البداية والنهاية والنقطة بينهما لتهريب القيمة المُمرَّرة إلى الدالة. يُمكِن استخدام الدالة <code>[[PHP/ord|()ord]]</code> لمعرفة قيمة رمز ASCII لأحد المحارف.<syntaxhighlight lang="php">
<?php
echo addcslashes("zoo['.']", 'z..A');
// \zoo['\.']
?>
</syntaxhighlight>انتبه عند محاولة تهريب المحارف 0 و a و b و f و n و r و t و v لأنه ستحوّل  إلى <code>0\</code> و <code>a\</code> و <code>b\</code> و <code>f\</code> و <code>n\</code> و <code>r\</code> و <code>t\</code> و <code>v\</code> والتي تعدّ محارف تهريب مُعَرَّفة مسبقًا لدى لغة  C واللغات البرمجية المشتقة منها، كما هو حال في لغة PHP. مما يؤدي إلى عدم الحصول على النتيجة المرغوبة في حال استعمال مخارج الدالة <code>addcslashes()‎</code> لتوليد الكود البرمجي بواسطة هذه الأحرف.

== القيم المعادة ==
تُعيد الدالة السلسلة النصية مع تهريب (escape) المحارف فيها.

== سجل التغييرات ==
{| class="wikitable"
!الإصدار
!الوصف
|-
|5.2.5
|أضيفت سلسلتا التهريب <code>‎/v</code> و <code>‎/f</code>.
|}

== أمثلة ==
ستُهرِّب  كل المحارف التي لها رمز ASCII قيمته محصورة بين 0 و 31 إذا كانت قيمة المتغير <code>charlist</code> تساوي <code>"‎\0..\37"</code>.

المثال 1: مثال بسيط عن الدالة <code>addcslashes()‎</code><syntaxhighlight lang="php">
<?php

$escaped = addcslashes($not_escaped, "\0..\37!@\177..\377");

?>


</syntaxhighlight>

== انظر أيضًا ==
* <code>[[PHP/stripcslashes|stripcslashes()‎]]</code>: حذف الخطوط المائلة العكسية التي أضيفت بواسطة الدالة <code>addcslashes()‎</code>.
* <code>[[PHP/stripslashes|stripslashes()‎]]</code>: حذف الخطوط المائلة العكسية.
* <code>[[PHP/addslashes|addslashes()‎]]</code>: تهريب سلسلة رموز باستعمال الخطوط المائلة العكسية.
* <code>[[PHP/htmlspecialchars|htmlspecialchars()‎]]</code>: تحويل الرموز الخاصة إلى عناصر HTML.
* <code>[[PHP/quotemeta|quotemeta()‎]]</code>: اقتباس المحارف الخاصة.

== مصادر ==
* [http://php.net/manual/en/function.addcslashes.php صفحة الدالة addcslashes في توثيق PHP الرسمي].
[[تصنيف:PHP]]
[[تصنيف:PHP Function]]
[[تصنيف:PHP String]]