Sviluppo

Chi è interessato a contribuire allo sviluppo ed al miglioramento può trovare le informazioni necessarie di seguito:

Fare il checkout dal repository SVN

Creare una copia locale su Ubuntu

Dopo aver installato subversion si possono prelevare il file di codice aggiornato da Sourceforge così:

svn checkout --username=anonymous https://svn.code.sf.net/p/gazie/code/ gazie

Normalmente vi ritroverete una /home/nome_utente/gazie aggiornata all'ultimo commit degli sviluppatori.

Creare una copia locale su Windows

Dopo aver installato TortoiseSVN si possono prelevare i file di codice aggiornato da Sourceforge così:

GAzie Coding Standards

Blocco commento di testa

Tutti i file di codice sorgente nella distribuzione GAzie dovrebbero contenere il seguente blocco di commento come intestazione:

<?php
/*
 -----------------------------------------------------------------------
                         GAzie - Gestione Azienda
    Copyright (C) 2004-2011 - Antonio De Vincentiis Montesilvano (PE)
                      <http://gazie.altervista.org>
 -----------------------------------------------------------------------
    Questo programma e` free software;   e` lecito redistribuirlo  e/o
    modificarlo secondo i  termini della Licenza Pubblica Generica GNU
    come e` pubblicata dalla Free Software Foundation; o la versione 2
    della licenza o (a propria scelta) una versione successiva.

    Questo programma  e` distribuito nella speranza  che sia utile, ma
    SENZA   ALCUNA GARANZIA; senza  neppure  la  garanzia implicita di
    NEGOZIABILITA` o di  APPLICABILITA` PER UN  PARTICOLARE SCOPO.  Si
    veda la Licenza Pubblica Generica GNU per avere maggiori dettagli.

    Ognuno dovrebbe avere   ricevuto una copia  della Licenza Pubblica
    Generica GNU insieme a   questo programma; in caso  contrario,  si
    scriva   alla   Free  Software Foundation,  Inc.,   675  Mass Ave,
    Cambridge, MA 02139, Stati Uniti.
 -----------------------------------------------------------------------
*/
?>

Non esiste una regola facile per determinare quando un collaboratore che apporta nuovo codice dovrebbe essere aggiunto alla lista degli autori di un dato file sorgente. In generale, le modifiche dovrebbero rientrare nella categoria "sostanziale" (che significa intorno al 10% - 20% delle modifiche del file). Eccezioni possono essere fatte per riscrivere le funzioni o per contribuire a nuova logica. Semplici correzioni, riorganizzazione o segnalazioni di bug non giustificherebbe l'aggiunta di un nuovo individuo alla lista degli autori.

Tabulazione e colonne

Per scrivere codice con i moderni editor di testo non è strettamente necessario usare i canonici 4 spazi di rientro per le tabulazioni e 80 colonne per rigo come nello standard Emacs. GAzie usa sempre caratteri spazio in luogo di quelli di tabulazione. Per approfondire l'argomento si può far riferimento a questo link: PEAR coding standards

(defun php-mode-hook ()
  (setq tab-width 4
        c-basic-offset 4
        c-hanging-comment-ender-p nil
        indent-tabs-mode
        (not
         (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
              (string-match "\.php$" (buffer-file-name))))))

Strutture di controllo

Esempi di if, for, while, switch, ecc. Ecco un esempio if, dal momento che è il più complicato di loro:

<?php
if ((condition1) || (condition2)) {
    action1;
} elseif ((condition3) && (condition4)) {
    action2;
} else {
    defaultaction;
}
?>

Le istruzioni di controllo dovrebbero avere uno spazio tra la parola chiave di controllo e parentesi di apertura, per distinguerle dalle chiamate di funzione. Si consiglia vivamente di utilizzare sempre le parentesi graffe, anche in situazioni in cui sono tecnicamente opzionali. Esse aumentano la leggibilità e riducono la possibilità di errori logici introdotte quando vengono aggiunte nuove linee.

Per istruzioni switch:

<?php
switch (condition) {
case 1:
    action1;
    break;

case 2:
    action2;
    break;

default:
    defaultaction;
    break;

}
?>

Le funzioni dovrebbero essere chiamate senza spazi tra il nome della funzione, la parentesi di apertura e il primo parametro ma solo spazi tra virgole e ogni parametro e senza spazio tra l'ultimo parametro, la parentesi di chiusura, e il punto e virgola.

Ecco un esempio:

<?php
$var = foo($bar, $baz, $quux);
?>

Per le dichiarazioni di funzione seguire la convenzione "One True Brace Style":

<?php
function fooFunction($arg1, $arg2 = '')
{
    if (condition) {
        statement;
    }
    return $val;
}
?>