1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>CGILua: geração de scripts para a Web usando Lua</title>
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"><a href="http://www.keplerproject.org"><img alt="Logotipo do CGILua" src="cgi-128.gif"/></a></div>
<div id="product_name"><big><strong>CGILua</strong></big></div>
<div id="product_description">Geração de scripts para a Web usando Lua</div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>CGILua</h1>
<ul>
<li><a href="index.html">Início</a>
<ul>
<li><a href="index.html#overview">Visão geral</a></li>
<li><a href="index.html#status">Status</a></li>
<li><a href="index.html#download">Download</a></li>
<li><a href="index.html#history">Histórico</a></li>
<li><a href="index.html#incompatibility">Incompatibilidades</a></li>
<li><a href="index.html#credits">Créditos</a></li>
<li><a href="index.html#contact">Fale conosco</a></li>
</ul>
</li>
<li><a href="manual.html">Manual</a>
<ul>
<li><a href="manual.html#intro">Introdução</a></li>
<li><a href="manual.html#installation">Instalação</a></li>
<li><a href="manual.html#config">Configuração</a></li>
<li><a href="manual.html#scripts">Lua Scripts</a></li>
<li><a href="manual.html#templates">Lua Pages</a></li>
<li><a href="manual.html#parameters">Parâmetros</a></li>
</ul>
</li>
<li><a href="reference.html">Referência</a>
<ul>
<li><a href="reference.html#headers">Cabeçalhos</a></li>
<li><a href="reference.html#contents">Geração de conteúdo</a></li>
<li><a href="reference.html#prep">Lua Pages</a></li>
<li><a href="reference.html#variables">Variáveis do CGILua</a></li>
<li><a href="reference.html#error_handling">Tratamento de erros</a></li>
<li><a href="reference.html#behavior">Comportamento do CGILua</a></li>
<li><a href="reference.html#urlcode">Codificação de URL</a></li>
<li><a href="reference.html#auxiliar">Funções auxiliares</a></li>
<li><a href="reference.html#index">Índice alfabético</a></li>
</ul>
</li>
<li><strong>Bibliotecas</strong>
<ul>
<li><a href="libraries.html#cookies">Cookies</a></li>
<li><a href="libraries.html#serialize">Serialize</a></li>
<li><a href="libraries.html#session">Session</a></li>
</ul>
</li>
<li><a href="sapi.html">SAPI</a></li>
<li><a href="license.html">Licenças</a></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h2>Visão geral</h2>
<p>O CGILua inclui um conjunto de bibliotecas externas que permite o tratamento de cookies, dados serializados e sessões. Para usar essas bibliotecas, basta usar a instrução <code>require</code> para solicitá-las no arquivo <code>config.lua</code> do CGILua.</p>
<h2><a name="cookies"></a>Cookies</h2>
<dl class="reference">
<dt><a name="get"></a><strong><code>cgilua.cookies.get (name)</code></strong></dt>
<dd>Obtém o valor do cookie com o <code>name</code> fornecido.<br/> Retorna uma string com o valor do cookie.</dd>
<dt><a name="set"></a><strong><code>cgilua.cookies.set (name, value[, options])</code></strong></dt>
<dd>Define o valor <code>value</code> do cookie com um <code>name</code> dado. Os nomes e valores de campos na tabela <code>options</code> são usados nos atributos do cookie. Esta função deve ser chamada antes do envio dos cabeçalhos HTTP e antes da geração de qualquer resultado.<br/> Não retorna nada.</dd>
<dt><a name="sethtml"></a><strong><code>cgilua.cookies.sethtml (name, value[, options])</code></strong></dt>
<dd>Define o valor <code>value</code> do cookie com um <code>name</code> dado. Esta função gera um elemento HTML <code><meta></code>, assim, ela deve ser chamada depois de produzida a tag HTML <code><head></code> e antes da tag <code></head></code> correspondente.<br/> Não retorna nada.</dd>
<dt><a name="delete"></a><strong><code>cgilua.cookies.delete (name[, options])</code></strong></dt>
<dd>Exclui um cookie com um <code>name</code> dado (define o valor como <code>xxx</code>).<br /> Não retorna nada.</dd>
</dl>
<hr/>
<h2><a name="serialize"></a>Serialize</h2>
<dl class="reference">
<dt><strong><code>cgilua.serialize (table, outfunc[, indent[, prefix]])</code></strong></dt>
<dd>Serializa uma <code>table</code> usando <code>outfunc</code> como a função usada para gerar o resultado; <code>indent</code> como uma string opcional com o padrão de identação; <code>prefix</code> como uma string opcional com o prefixo de identação (usado para armazenar o recuo real entre as chamadas recursivas).<br/> Observe que há algumas restrições: os valores dos tipos <em>function</em> e <em>userdata</em> não podem ser serializados; as tabelas que contêm ciclos também não podem ser serializadas.<br/> Não retorna nada.</dd>
</dl>
<hr/>
<h2><a name="session"></a>Session</h2>
<dl class="reference">
<dt><a name="close"></a><strong><code>cgilua.session.close ()</code></strong></dt>
<dd>Fecha a sessão de usuário. Salva todos os dados em <code>cgilua.session.data</code> no sistema de armazenamento em uso (normalmente, o sistema de arquivos). Esta função deve ser chamada depois que o script terminar de ser executado. Para garantir que isso ocorra, recomenda-se usar a <a href="reference.html#addclosefunction">addclosefunction</a> no arquivo de configuração.<br/> Não retorna nada.</dd>
<dt><a name="data"></a><strong><code>cgilua.session.data</code></strong></dt>
<dd>Tabela que contém os dados sobre a sessão de usuário.</dd>
<dt><a name="delete"></a><strong><code>cgilua.session.delete (id)</code></strong></dt>
<dd>Exclui uma sessão. O argumento <code>id</code> é o identificador da sessão.<br/> Não retorna nada.</dd>
<dt><a name="load"></a><strong><code>cgilua.session.load (id)</code></strong></dt>
<dd>Carrega dados de uma sessão. O argumento <code>id</code> é o identificador da sessão.<br/> Retorna uma tabela com os dados da sessão ou <code>nil</code> seguido de uma mensagem de erro.</dd>
<dt><a name="new"></a><strong><code>cgilua.session.new ()</code></strong></dt>
<dd>Cria um novo identificador de sessão.<br/> Retorna o novo identificador de sessão.</dd>
<dt><a name="open"></a><strong><code>cgilua.session.open ()</code></strong></dt>
<dd>Abre a sessão de usuário. Cria a tabela <code>cgilua.session.data</code>. Esta função deve ser chamada imediatamente antes da execução do script, mas após o processamento dos cabeçalhos da solicitação. Para garantir que isso ocorra, recomenda-se usar a <a href="reference.html#addopenfunction">addopenfunction</a> no arquivo de configuração.<br/> Não retorna nada.</dd>
<dt><a name="save"></a><strong><code>cgilua.session.save (id, data)</code></strong></dt>
<dd>Salva <code>data</code> em uma sessão com um <code>id</code>.<br /> Não retorna nada.</dd>
<dt><a name="setsessiondir"></a><strong><code>cgilua.session.setsessiondir (path)</code></strong></dt>
<dd>Define o diretório temporário da sessão. O argumento <code>path</code> é uma string com o novo diretório.<br/> Não retorna nada.</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="XHTML 1.0 válido!" height="31" width="88" /></a></p>
<p><small>$Id: libraries.html,v 1.3 2005/11/03 18:48:57 carregal Exp $</small></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|