쿠키 헬퍼

쿠키 헬퍼에는 쿠키 작업을 지원하는 기능이 포함되어 있습니다.

헬퍼 로드

이 헬퍼는 다음 코드를 사용하여 로드됩니다.

<?php

helper('cookie');

사용 가능한 함수

사용 가능한 함수는 다음과 같습니다.

Parameters:
  • $name (mixed) – 이 함수에 사용 가능한 모든 매개 변수의 쿠키 이름 또는 연관 배열
  • $value (string) – 쿠키 값
  • $expire (int) – 만료까지의 시간 (초)
  • $domain (string) – 쿠키 도메인 (일반적으로 .yourdomain.com)
  • $path (string) – 쿠키 경로
  • $prefix (string) – 쿠키 이름 접두사. ''인 경우 app/Config/Cookie.php의 기본값이 사용됩니다.
  • $secure (bool) – HTTPS를 통해서만 쿠키를 보낼지 여부
  • $httpOnly (bool) – JavaScript에서 쿠키를 숨길 지 여부
  • $sameSite (string) – SameSite 쿠키 매개변수의 값입니다. null인 경우 app/Config/Cookie.php의 기본값이 사용됩니다.
Return type:

void

브라우저 쿠키를 설정하기 위한 보다 친근한 구문을 제공합니다. 이 함수는 Response::setCookie()의 별칭이므로, 사용법에 대한 설명은 Response 라이브러리를 참조하십시오.

Parameters:
  • $index (string) – 쿠키 이름
  • $xssClean (bool) – 반환된 값에 XSS 필터링을 적용할지 여부
  • $prefix (string) – 쿠키 이름 접두사. ''로 설정하면 app/Config/Cookie.php의 기본값이 사용됩니다. null로 설정하면 접두사 없음
Returns:

쿠키 값 또는 찾지 못한 경우 null
Return type:

mixed

Note

v4.2.1부터 세 번째 매개변수 $prefix가 도입되었으며 버그 수정으로 인해 동작이 약간 변경되었습니다. 자세한 내용은 업그레이드를 참조하세요.

이 헬퍼 함수는 브라우저 쿠키를 얻기 위한 보다 친숙한 구문을 제공합니다. 이 함수는 app/Config/Cookie.php 파일에 설정된 Config\Cookie::$prefix를 추가한다는 점을 제외하고는 IncomingRequest::getCookie()와 매우 유사하게 작동하므로 자세한 사용법은 IncomingRequest 라이브러리를 참조하십시오.

Warning

XSS 필터링을 사용하는 것은 나쁜 습관입니다. XSS 공격을 완벽하게 차단하지는 않습니다. 뷰(view)에서 올바른 $context와 함께 esc()를 사용하는 것이 좋습니다.

Parameters:
  • $name (string) – 쿠키 이름
  • $domain (string) – 쿠키 도메인 (일반적으로 .yourdomain.com)
  • $path (string) – 쿠키 경로
  • $prefix (string) – 쿠키 이름 접두사
Return type:

void

쿠키를 삭제할 수 있습니다. 필수값으로 쿠키 이름만 필요하며, 사용자 정의 경로나 다른 값을 설정하지 않아도 됩니다.

<?php

delete_cookie('name');

이 함수는 value와 expire 변수가 없다는 점을 제외하면 set_cookie()와 동일합니다.

Note

set_cookie()를 사용할 때 value가 빈 문자열로 설정되고 expire가 0으로 설정되면 쿠키가 삭제됩니다. value가 비어 있지 않은 문자열로 설정되고 expire가 0으로 설정되면 쿠키는 브라우저가 열려 있는 동안에만 지속됩니다.

첫 번째 매개 변수에 값 배열이나 불연속 매개 변수(discrete parameters)를 설정할 수 있습니다.

<?php

delete_cookie($name, $domain, $path, $prefix);
Parameters:
  • $name (string) – 쿠키 이름
  • $value (string|null) – 쿠키 값
  • $prefix (string) – 쿠키 접두사(prefix)
Return type:

bool

이름으로 쿠키가 있는지 확인합니다. Response::hasCookie()의 별칭(alias)입니다..