[WebSquare5/SP4] ep03. API - $p.local

HTML5의 LocalStorage와 동일한 기능을 제공. LocalStorage는 도메인(사이트) 별로 브라우저에서 제공하는 임의의 영역에 데이터를 저장하는 기능으로 브라우저 설정에 따라 저장할 수 있는 데이터 양이 결정됨

 

IE 하위 버전도 지원. (세부 내용 및 스펙은 http://www.w3.org/TR/webstorage/#storage 참조.)

Web Storage (Second Edition)

 

cookie와 비슷하지만 만료일이 따로 없고 브라우저에 따라 저장 가능 용량은 5MB ~ 10MB 사이. 멀티브라우징을 위해서는 5MB 이하로 저장하는 것을 권장.

 

 

---

▷ $p.local ◁

---

☞ $p.local.clear();

clear( )

 

동일한 도메인으로 localStorage에 저장 된 데이터를 삭제합니다.

 

Sample

$p.local.clear();

---

☞ $p.local.getAllItem();

getAllItem( )

 

동일한 도메인으로 localStorage에 저장 된 모든 데이터를 key,value형태의 객체로 반환합니다.

 

Return

type	description
JSON	key,value가 저장 된 JSON 객체.

 

Sample

var tmpData = $p.local.getAllItem(); //return 예시 ) { name:"WebSquare" , add:"서울시" }

---

☞ $p.local.getItem();

getItem( keyName )

 

LocalStorage에서 keyName에 해당하는 값을 반환한다.

 

Parameter

name	type	required	description
keyName	String	Y	저장 한 key 값.

Return

type	description
String	keyName과 매칭 된 데이터가 있으면 value를 반환하며, 그렇지 않을 경우 null을 반환한다.

 

Sample - name라는 key로 "WebSquare"가 저장되어 있는 경우

$p.local.getItem("name");
return 예시 ) "WebSquare"

---

☞ $p.local.key();

key( index )

 

index에 해당하는 키값을 가져옵니다. 저장 된 key의 index(순서)는 브라우저에 정의 된 것에 따라 다르다. 즉, 브라우저마다 key의 index가 다를 수 있다.

 

Parameter

name	type	required	description
index	Number	Y	저장 된 key의 index.

 

Return

type	description
String	index에 해당하는 key값을 반환하며, 그렇지 않을 경우 null을 반환한다.

 

Sample - 대표적인 브라우저 중 chorme과 ie를 비교 했을 때 chrome은 마지막에 저장 한 값이 0번째로 나오며 ie의 경우 첫번째로 저장 한 값이 0번째로 나온다.

$p.local.key(0);
return 예시 ) "name"

---

☞ $p.local.length();

length( )

로컬 스토리지의 (key, value)쌍의 데이터의 개수를 나타내는 값.

 

Return

type	description
Number	로컬 스토리지에 저장 된 데이터(key/value)의 개수.

 

Sample

$p.local.length
return 예시 ) 2

---

☞ $p.local.removeItem();

removeItem( key )

 

keyName에 해당하는 데이터(item)을 삭제한다.
모든 데이터를 삭제 할 경우 clear()함수를 호출한다.

 

Parameter

name	type	required	description
key	String	Y	삭제하고자 하는 데이터(item)의 key값

 

Sample - name에 해당하는 item을 삭제

 $p.local.removeItem("name");

---

☞ $p.local.setItem();

setItem( keyName , value )

 

localStorage에 key와 value로 이루어진 데이터(item)를 저장합니다.

 

Parameter

name	type	required	description
keyName	String	Y	저장 할 key
value	String	Y	저장 할 value

 

Sample - name라는 key로 WebSquare라는 값을 저장

$p.local.setItem("name", "WebSquare");

---