Miglioramento dei commenti su alcune classi

This commit is contained in:
Thomas Zilio 2020-08-07 10:43:14 +02:00
parent b93c4dd259
commit 41d4f6971c
8 changed files with 71 additions and 11 deletions

View File

@ -41,13 +41,13 @@ class Articolo extends Model
}
/**
* Funzione per inserire i movimenti di magazzino.
* Funzione per registrare un movimento del magazzino in relazione all'articolo corrente, modificando di conseguenza la quantità dell'articolo stesso.
*
* @param $qta
* @param null $descrizone
* @param null $data
* @param bool $manuale
* @param array $array
* @param string $descrizone
* @param string $data
* @param bool $manuale
* @param array $array
*
* @return bool
*/
@ -65,13 +65,13 @@ class Articolo extends Model
}
/**
* Funzione per registrare i movimenti di magazzino.
* Funzione per registrare un movimento del magazzino in relazione all'articolo corrente, senza movimentare la quantità dell'articolo stesso.
*
* @param $qta
* @param null $descrizone
* @param null $data
* @param bool $manuale
* @param array $array
* @param string $descrizone
* @param string $data
* @param bool $manuale
* @param array $array
*
* @return bool
*/
@ -97,6 +97,12 @@ class Articolo extends Model
return $id;
}
/**
* Imposta il prezzo di vendita sulla base dell'impstazione per l'utilizzo dei prezzi comprensivi di IVA.
*
* @param $prezzo_vendita
* @param $id_iva
*/
public function setPrezzoVendita($prezzo_vendita, $id_iva)
{
$this->idiva_vendita = $id_iva;

View File

@ -4,6 +4,15 @@ namespace Modules\Articoli;
use Common\Model;
/**
* Classe dedicata alla gestione dei movimenti di magazzino degli articoli.
*
* Alcuni appunti sull'utilizzo dei campi *idsede_azienda* e *idsede_controparte*
* Il campo *idsede_azienda* è relativo alla sede dell'Azienda che è interessata dal movimento, mentre *idsede_controparte* indica la sede del Cliente/Fornitore controparte.
* La natura effettiva del movimento (e di *idsede_controparte*) è quindi identificabile dal valore del campo *qta*: se positivo il magazzino è aumentatao (movimento da *idsede_controparte* a *idsede_azienda*), se negativo il magazzino è diminuito (movimento da *idsede_azienda* a *idsede_controparte*).
*
* Si noti che il valore "0" per i campi *idsede_* indica solitamente una Sede legale dell'Anagrafica di riferimento. Solo se il movimento non è associato ad alcun documento il campo *idsede_controparte* non segue questo significato, poichè il movimento in questo caso è considerato manuale.
*/
class Movimento extends Model
{
protected $document;
@ -72,6 +81,11 @@ class Movimento extends Model
return $this->hasOne(Articolo::class, 'idarticolo');
}
/**
* Restituisce un insieme di movimenti appartenenti allo stesso documento.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function movimentiRelativi()
{
return $this->hasMany(Movimento::class, 'idarticolo', 'idarticolo')
@ -79,11 +93,21 @@ class Movimento extends Model
->where('reference_id', $this->reference_id);
}
/**
* Verifica se è disponibile un documento associato al movimento.
*
* @return bool
*/
public function hasDocument()
{
return isset($this->reference_type);
}
/**
* Verifica se il movimento è manuale oppure automatico.
*
* @return bool
*/
public function isManuale()
{
return !empty($this->manuale);
@ -106,6 +130,14 @@ class Movimento extends Model
return $this->document;
}
/**
* Restituisce una descrizione standard applicabile a un movimento sulla base della relativa quantità e alla direzione.
*
* @param $qta
* @param string $direzione
*
* @return string
*/
public static function descrizioneMovimento($qta, $direzione = 'entrata')
{
if (empty($direzione)) {

View File

@ -5,6 +5,11 @@ namespace Modules\Fatture\Gestori;
use Modules\Fatture\Components;
use Modules\Fatture\Fattura;
/**
* Classe dedicata alla gestione del Bollo per la Fattura, compreso il calcolo del relativo valore e la generazione dinamica della riga associata.
*
* @since 2.4.17
*/
class Bollo
{
private $fattura;

View File

@ -6,6 +6,11 @@ use Modules\Fatture\Fattura;
use Modules\PrimaNota\Mastrino;
use Modules\PrimaNota\Movimento;
/**
* Classe indirizzata alla gestione dei Movimenti automatici (non contabili, ovvero non di Prima Nota) associati a una Fattura.
*
* @since 2.4.17
*/
class Movimenti
{
protected $fattura;

View File

@ -5,6 +5,11 @@ namespace Modules\Fatture\Gestori;
use Modules\Fatture\Fattura;
use Modules\Scadenzario\Scadenza;
/**
* Classe dedicata alla gestione delle procedure di registrazione delle Scadenze di pagamento per una Fattura, con relativo supporto alla Fatturazione Elettronica per permettere l'importazione delle scadenze eventualmente registrate.
*
* @since 2.4.17
*/
class Scadenze
{
private $fattura;

View File

@ -44,7 +44,7 @@ class ChoicesHandler implements HandlerInterface
}
$class = '';
if (in_array('disabled', $extras)){
if (in_array('disabled', $extras)) {
$class = ' disabled';
}

View File

@ -5,6 +5,11 @@ namespace Importer;
use Filter;
use League\Csv\Reader;
/**
* Classe dedicata alla gestione dell'importazione da file CSV.
*
* @since 2.4.17
*/
abstract class CSVImporter implements ImporterInterface
{
protected $csv;

View File

@ -4,6 +4,8 @@ namespace Importer;
/**
* Interfaccia che definisce la struttura di base per la gestione delle importazioni di documenti come dati del gestionale.
*
* @since 2.4.17
*/
interface ImporterInterface
{