هلپرفانکشن Cookie

مجتبی پاکزاد کدایگنایتر 3.1.9 در حال تکمیل رایگان

فایل هلپر Cookie حاوی فانکشن‌هایی است که به شما در کار با کوکی‌ها کمک می‌کنند.

نحوه بارگذاری این هلپرفانکشن

با کد زیر می‌توانید این هلپرفانکشن را لود کنید:

$this->load->helper('cookie');

فانکشن‌های موجود

با لود این هلپر، فانکشن‌های زیر در دسترس خواهند بود:

set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = NULL[, $httponly = NULL]]]]]]])
پارامترها
  • $name نوع mixed - نام کوکی یا آرایه انجمنی از تمام پارامترهای موجود برای این فانکشن
  • $value نوع استرینگ - مقدار کوکی
  • $expire نوع عدد صحیح - طول عمر کوکی بر حسب ثانیه
  • $domain نوع استرینگ - دامنه کوکی (معمولا .yourdomain.com)
  • $path نوع استرینگ - مسیر کوکی
  • $prefix نوع استرینگ - پیشوند نام کوکی
  • $secure نوع بولین - آیا کوکی فقط از طریق پروتکل HTTPS ارسال شود
  • $httponly نوع بولین - آیا کوکی از دید جاوااسکریپت شود
نوع مقدار بازگشتی void (ندارد.)

این فانکشن سینتکس دوستانه‌تری را برای سِت کردن کوکی‌های مرورگر در اختیارتان قرار می‌دهد. برای توضیح نحوه کار این فانکشن به لایبرری Input مراجعه کنید، به این دلیل که این فانکشن نام مستعاری برای CI_Input::set_cookie() است.

get_cookie($index[, $xss_clean = NULL])
پارامترها
  • $index نوع استرینگ - نام کوکی
  • $xss_clean نوع بولین - آیا فیلترینگ XSS بر روی مقادیر بازگشتی اعمال شود
مقدار بازگشتی مقدار کوکی و یا NULL در صورت پیدا نکردن کوکی
نوع مقدار بازگشتی void (ندارد.)

این فانکشن سینتکس دوستانه‌تری را برای گرفتن کوکی‌های مرورگر در اختیارتان قرار می‌دهد. برای توضیح بیشتر درباره نحوه کار این فانکشن به لایبرری Input مراجعه کنید، به این دلیل که این فانکشن خیلی شبیه به CI_Input::cookie() عمل می‌کند، به جز این که این فانکشن مقدار $config['cookie_prefix'] را نیز به همراه دارد که در فایل application/config/config.php می‌توانید مقدار آن را سِت کرده باشید.

delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]])
پارامترها
  • $name نوع mixed - نام کوکی
  • $domain نوع استرینگ - دامنه کوکی (معمولا .yourdomain.com)
  • $path نوع استرینگ - مسیر کوکی
  • $prefix نوع استرینگ - پیشوند نام کوکی
نوع مقدار بازگشتی void (ندارد.)

این فانکشن امکان حذف کوکی را به شما می‌دهد. اگر در هنگام ساخت کوکی از پارامترهای دیگر مانند $path استفاده نکرده باشید، برای حذف کوکی فقط باید نام آن را به این فانکشن بدهید.

delete_cookie('name');

این فانکشن دقیقا همان فانکشن set_cookie() است، با این تفاوت که پارامترهای value و expiration را ندارد، می‌توانید یک آرایه حاوی نام کوکی‌های مورد نظر خود برای حذف را به عنوان پارامتر به این فانکشن بدهید، یا کوکی‌ها را به صورت مجزا حذف کنید که در این صورت کافی است نام کوکی را به صورت استرینگ به پارامتر اول فانکشن بدهید.

delete_cookie($name, $domain, $path, $prefix);
منبع
Cookie Helper