Changes between Version 1 and Version 2 of phpgwapi/how_does_API_work

Timestamp:

03/29/10 15:52:00 (14 years ago)

Author:

rodsouza

Comment:

--

phpgwapi/how_does_API_work

@@ -123 +123 @@
 
 O script '''/phpgwapi/setup/setup.inc.php''' define dados sobre a API, além das tabelas utiliadas.
-
 
 {{{
@@ -155 +154 @@
     $setup_info[ 'phpgwapi' ][ 'tables' ][ ] = 'phpgw_async';
 }}}
+
+Caso a variável '''$GLOBALS[ 'phpgw_info' ][ 'flags' ][ 'noapi' ]''' não tenha o valor '''true''' então é realizada a inclusão dos scripts a seguir, todos localizados no diretório de classes da '''API'''.
+
+
+{{{
+#!php
+    if ( ! isset( $GLOBALS[ 'phpgw_info' ][ 'flags' ][ 'noapi' ] ) || ! $GLOBALS[ 'phpgw_info' ][ 'flags' ][ 'noapi' ] == true )
+    {
+        include( PHPGW_API_INC . '/functions.inc.php' );
+        include( PHPGW_API_INC . '/xml_functions.inc.php' );
+        include( PHPGW_API_INC . '/soap_functions.inc.php' );
+    }
+}}}
+
+O script '''/phpgwapi/inc/functions.inc.php''' inicia incluindo o script '''/phpgwapi/inc/common_functions.inc.php'''. Após algumas variáveis são populas caso o ExpressoLivre esteja utilizando o formato multi-domínios.
+
+Em seguida as classes '''phpgw''' e '''db''' são instanciadas.
+
+{{{
+#!php
+    $GLOBALS[ 'phpgw' ] = CreateObject( 'phpgwapi.phpgw' );
+    $GLOBALS[ 'phpgw' ]->db = CreateObject( 'phpgwapi.db' );
+}}}
+
+Com a instância da classe referente à base de dados uma tentativa de conexão com à base é realizada.
+
+{{{
+#!php
+    if (!
+    $GLOBALS['phpgw']->db->connect(
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_name' ],
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_host' ],
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_port' ],
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_user' ],
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_pass' ],
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ 'db_type' ]
+    ) )
+}}}
+
+Caso não seja possível conectar-se então o famigerado erro '''Código 001''' é exibido.
+
+A etapa seguinte é popular informações sobre o servidor proveniente da base de dados em '''$GLOBALS[ 'phpgw_info' ][ 'server' ]'''.
+
+{{{
+#!php
+    $GLOBALS[ 'phpgw' ]->db->query( "SELECT * from phpgw_config WHERE config_app='phpgwapi'", __LINE__, __FILE__ );
+    while ( $GLOBALS[ 'phpgw' ]->db->next_record( ) )
+    {
+        $GLOBALS[ 'phpgw_info' ][ 'server' ][ $GLOBALS[ 'phpgw' ]->db->f( 'config_name' ) ] = stripslashes( $GLOBALS[ 'phpgw' ]->db->f( 'config_value' ) );
+    }
+}}}
+
+Segue um exemplo de '''$GLOBALS[ 'phpgw_info' ][ 'server' ]''' populada.
+
+{{{
+    [server] => Array
+        (
+            [header_admin_user] => expresso-admin
+            [header_admin_password] => e8d95a51f3af4a3b134bf6bb680a213a
+            [setup_acl] => 
+            [captcha] => 0
+            [num_badlogin] => 0
+            [atributoexpiracao] => 
+            [atributousuarios] => 
+            [certificado] => 0
+            [use_assinar_criptografar] => 0
+            [num_max_certs_to_cipher] => 0
+            [use_https] => 0
+            [sugestoes_email_to] => 
+            [domain_name] => 
+            [use_prefix_organization] => 
+            [show_domain_selectbox] => 
+            [db_persistent] => 
+            [sessions_type] => php4
+            [mcrypt_enabled] => 
+            [versions] => Array
+                (
+                    [mcrypt] => 
+                    [phpgwapi] => 2.2.000
+                    [current_header] => 2.0
+                    [header] => 2.0
+                )
+
+            [mcrypt_iv] => iwktq671fBY9ZZu1GNpCL8FrzIq4Y
+            [default_domain] => default
+            [db_host] => localhost
+            [db_port] => 5432
+            [db_name] => expresso
+            [db_user] => postgres
+            [db_pass] => 
+            [db_type] => pgsql
+            [site_title] => Expresso Livre
+            [max_access_log_age] => 20
+            [block_time] => 1
+            [num_unsuccessful_id] => 50
+            [num_unsuccessful_ip] => 500
+            [disable_autoload_langfiles] => True
+            [showpoweredbyon] => bottom
+            [holidays_url_path] => localhost
+            [usecookies] => True
+            [install_id] => eb6dc5e478cafcab4286441bec7a1e5b
+            [ldap_root_pw] => senha
+            [cal_expressoMail] => 1.2
+            [image_type] => 1
+            [useframes] => never
+            [sessions_app_timeout] => 1
+            [deny_user_grants_access] => True
+            [cal_type_tree_participants] => 3
+            [auto_search] => True
+            [temp_dir] => /tmp
+            [files_dir] => /home/projetos/expresso
+            [webserver_url] => /expresso
+            [hostname] => 127.0.0.1
+            [auth_type] => ldap
+            [account_repository] => ldap
+            [sql_encryption_type] => md5
+            [account_min_id] => 1000
+            [account_max_id] => 1000000
+            [name_jabber] => 127.0.0.1
+            [resource_jabber] => celepar
+            [port_jabber] => 8888
+            [server_webjabber] => 127.0.0.1
+            [server_ldap_jabber] => 127.0.0.1
+            [context_ldap_jabber] => dc=ecelepar10631
+            [user_ldap_jabber] => cn=admin
+            [password_ldap_jabber] => senha
+            [server_ldap_jabberit] => localhost
+            [context_ldap_jabberit] => dc=ecelepar10631
+            [user_ldap_jabberit] => uid=expresso-admin,ou=celepar,dc=ecelepar10631
+            [password_ldap_jabberit] => senha
+            [auto_create_expire] => never
+            [acl_default] => deny
+            [ldap_host] => 127.0.0.1
+            [ldap_context] => dc=ecelepar10631
+            [ldap_group_context] => dc=ecelepar10631
+            [ldap_root_dn] => cn=admin,dc=ecelepar10631
+            [ldap_encryption_type] => md5
+            [ldap_version3] => True
+            [mcrypt_algo] => tripledes
+            [mcrypt_mode] => cbc
+            [file_repository] => sql
+            [file_store_contents] => filesystem
+            [tz_offset] => -2
+            [asyncservice] => off
+            [lang_ctimes] => a:3:{s:2:"en";a:2:{s:5:"admin";i:1268134511;s:11:"preferences";i:1268134514;}s:5:"es-es";a:2:{s:5:"admin";i:1268134511;s:11:"preferences";i:1268134514;}s:5:"pt-br";a:2:{s:5:"admin";i:1268134511;s:11:"preferences";i:1268134514;}}
+            [name_jabberit] => im.pr.gov.br
+            [port_jabberit] => 5223
+            [resource_jabberit] => ECELEPAR10631
+            [use_ssl_jabberit] => true
+            [use_proxy_java] => false
+            [name_company_applet_jabberit] => Celepar
+            [mail_server] => localhost
+            [mail_port] => 143
+            [sessions_timeout] => 14400
+        )
+}}}