Changes between Version 3 and Version 4 of phpgwapi/dev

Timestamp:

11/05/09 09:03:38 (15 years ago)

Author:

amuller

Comment:

--

phpgwapi/dev

@@ -163 +163 @@
 
 [[Image(apiframe.jpg)]]
+
+ == 3. As funções da API ==
+ == 3.1 Métodos básicos ==
+{{{
+$GLOBALS['phpgw']->link($url, $args)
+}}}
+Formata a url para utilização em links ao invés dos endereços absolutos.
+
+ == 3.2 Métodos de aplicações ==
+{{{
+$GLOBALS['phpgw']->phpgw_header()
+}}}
+Imprime o cabeçalho html.
+{{{
+$GLOBALS['phpgw']->phpgw_footer()
+}}}
+Imprime o rodapé e inclui appname/inc/footer.php
+{{{
+$GLOBALS['phpgw']->common->phpgw_exit();
+}}}
+Fecha o processamento do script
+{{{
+$GLOBALS['phpgw']->template;
+}}}
+Utilizado para criar formulários via arquivos .tpl (obs. tende a ficar depreciado)
+ == 3.3 Funções de arquivos ==
+Pode ser lida em [http://docs.phpgroupware.org/contrib/vfs/vfs.html]
+ == 3.4 Outras funções == 
+Funções de email e funções de AJAX estão em discussão no momento
+
+ == 4. Os atributos da API ==
+
+ == 4.1 Informações de usuários ==
+
+$GLOBALS!['phpgw_info']!['user']!['userid'] = ID do usuário
+
+$GLOBALS!['phpgw_info']!['user']!['sessionid'] = ID da sessão
+
+$GLOBALS!['phpgw_info']!['user']!['theme'] = Tema selecionado
+
+$GLOBALS!['phpgw_info']!['user']!['firstname'] = Primeiro nome do usuário
+
+$GLOBALS!['phpgw_info']!['user']!['lastname'] = Último nome do usuário
+
+$GLOBALS!['phpgw_info']!['user']!['fullname'] = Nome completo do usuário
+
+$GLOBALS!['phpgw_info']!['user']!['groups'] = Grupos que o usuário está fazendo parte
+
+$GLOBALS!['phpgw_info']!['user']!['app_perms'] = Guarda se o usuário tem acesso ao aplicativo
+
+$GLOBALS!['phpgw_info']!['user']!['lastlogin'] = Hora (tempo) do ultimo login
+
+$GLOBALS!['phpgw_info']!['user']!['lastloginfrom'] = Aonde eles se logaram da última vez
+
+$GLOBALS!['phpgw_info']!['user']!['lastpasswd_change'] = Ultima vez que mudaram seus passwords
+
+$GLOBALS!['phpgw_info']!['user']!['passwd'] = Password encriptado
+
+$GLOBALS!['phpgw_info']!['user']!['status'] = Está habilitado?
+
+$GLOBALS!['phpgw_info']!['user']!['logintime'] = Qual foi a hora do login
+
+$GLOBALS!['phpgw_info']!['user']!['session_dla'] = Ultima requisição
+
+$GLOBALS!['phpgw_info']!['user']!['session_ip'] = Endereço IP corrente
+
+ == 4.2 Informações de servidor ==
+
+$GLOBALS!['phpgw_info']!['server']!['server_root'] = raíz do servidor
+
+$GLOBALS!['phpgw_info']!['server']!['include_root'] = Local do 'inc'
+
+$GLOBALS!['phpgw_info']!['server']!['temp_dir'] = Diretório temporário
+
+$GLOBALS!['phpgw_info']!['server']!['files_dir'] = Diretório de usuários de grupos
+
+$GLOBALS!['phpgw_info']!['server']!['template_dir'] = Arquivos do template carregado
+
+$GLOBALS!['phpgw_info']!['server']!['dir_separator'] = separador (compatibilidade com windows)
+
+$GLOBALS!['phpgw_info']!['server']!['encrpytkey'] = chave para criptografia
+
+$GLOBALS!['phpgw_info']!['server']!['site_title'] = Título do site
+
+$GLOBALS!['phpgw_info']!['server']!['webserver_url'] = URL do site
+
+$GLOBALS!['phpgw_info']!['server']!['hostname'] = Nome do servidor
+
+$GLOBALS!['phpgw_info']!['server']!['charset'] = Charset, default:iso-8859-1
+
+$GLOBALS!['phpgw_info']!['server']!['version'] = Versão da API
+
+== 4.3 Informações de banco de dados ==
+
+'''Por favor não utilize isto, porque $GLOBALS!['phpgw']->db já faz isso para você. A não ser que você deseje criar um problema.'''
+
+$GLOBALS!['phpgw_info']!['server']!['db_host'] = endereço do banco
+
+$GLOBALS!['phpgw_info']!['server']!['db_name'] = nome do banco
+
+$GLOBALS!['phpgw_info']!['server']!['db_user'] = usuário do banco
+
+$GLOBALS!['phpgw_info']!['server']!['db_pass'] = Senha do banco
+
+$GLOBALS!['phpgw_info']!['server']!['db_type'] = Tipo do banco pode ser MSSQL Server, MySQL and PostgreSQL.
+
+== 4.4 Informações de email ==
+
+'''Esta seria a definição dos atributos do Egroupware. Infelizmente não confie nisso'''
+
+$GLOBALS!['phpgw_info']!['server']!['mail_server'] = endereço do servidor IMAP
+
+$GLOBALS!['phpgw_info']!['server']!['mail_server_type'] = IMAP ou POP3
+
+$GLOBALS!['phpgw_info']!['server']!['imap_server_type'] = Tipo do IMAP Courier/Cyrus, Uwash ou UW-Maildir
+
+$GLOBALS!['phpgw_info']!['server']!['imap_port'] = Normalmente 143
+
+$GLOBALS!['phpgw_info']!['server']!['mail_suffix'] = Nome do domínio
+
+$GLOBALS!['phpgw_info']!['server']!['smtp_server'] = Endereço do servidor SMTP
+
+$GLOBALS!['phpgw_info']!['server']!['smtp_port'] = Normalmente 25
+
+== 4.5 Informações de aplicação ==
+
+$GLOBALS!['phpgw_info']!['apps']![$appname]!['title'] = Título da aplicação.
+
+$GLOBALS!['phpgw_info']!['apps']![$appname]!['enabled'] = Se ela está habilitada
+
+$GLOBALS!['phpgw_info']!['server']!['app_include_dir'] = Local do inc
+
+$GLOBALS!['phpgw_info']!['server']!['app_template_dir'] = Local do template da aplicação
+
+$GLOBALS!['phpgw_info']!['server']!['app_lang_dir'] = Local do diretório lang
+
+$GLOBALS!['phpgw_info']!['server']!['app_current'] = Nome da aplicação corrente