Skip to content

añadidos comentarios a las propiedades de los modelos del plugin #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NeoRazorX merged 1 commit into from
Jul 17, 2026
Merged

añadidos comentarios a las propiedades de los modelos del plugin #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Model/BalanceAccount.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ class BalanceAccount extends ModelClass
{
use ModelTrait;

/** @var string */
/** @var string código de la cuenta contable */
public $codcuenta;

/** @var string */
/** @var string descripción de la cuenta contable */
public $desccuenta;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id del código de balance al que pertenece esta cuenta */
public $idbalance;

public function getBalanceCode(): BalanceCode
Expand Down
26 changes: 13 additions & 13 deletions Model/BalanceCode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,43 +30,43 @@ class BalanceCode extends ModelClass
{
use ModelTrait;

/** @var string */
/** @var string modo de cálculo del saldo: positive, negative o según la naturaleza */
public $calculation;

/** @var string */
/** @var string código del balance */
public $codbalance;

/** @var string */
/** @var string descripción del nivel 1 */
public $description1;

/** @var string */
/** @var string descripción del nivel 2 */
public $description2;

/** @var string */
/** @var string descripción del nivel 3 */
public $description3;

/** @var string */
/** @var string descripción del nivel 4 */
public $description4;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var string */
/** @var string código del nivel 1 */
public $level1;

/** @var string */
/** @var string código del nivel 2 */
public $level2;

/** @var string */
/** @var string código del nivel 3 */
public $level3;

/** @var string */
/** @var string código del nivel 4 */
public $level4;

/** @var string */
/** @var string naturaleza del balance: A (activo) o P (pasivo) */
public $nature;

/** @var string */
/** @var string subtipo de balance: normal, abbreviated o pymes */
public $subtype;

public function calculate(float $debe, float $haber): float
Expand Down
32 changes: 16 additions & 16 deletions Model/Report.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,52 +41,52 @@ class Report extends ModelClass
const TYPE_PIE = 'pie';
const TYPE_TREE_MAP = 'treemap';

/** @var int */
/** @var int id del informe con el que se compara este */
public $compared;

/** @var string */
/** @var string fecha y hora de creación */
public $creationdate;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var string */
/** @var string nombre del informe */
public $name;

/** @var string */
/** @var string tabla de origen de los datos del informe */
public $table;

/** @var string */
/** @var string etiqueta usada para agrupar informes */
public $tag;

/** @var string */
/** @var string tipo de gráfico: bar, doughnut, area, map, pie o treemap */
public $type;

/** @var string */
/** @var string columna o expresión SQL usada para los valores del eje X */
public $xcolumn;

/** @var string */
/** @var string operación de transformación aplicada a la columna del eje X (p. ej. MONTHS, YEAR) */
public $xoperation;

/** @var string */
/** @var string columna o expresión SQL usada para los valores del eje Y */
public $ycolumn;

/** @var string */
/** @var string operación de agregación aplicada a la columna del eje Y (SUM, COUNT, AVERAGE...) */
public $yoperation;

/** @var bool */
/** @var bool indica si están activadas las funciones avanzadas del informe (SQL crudo, joins personalizados, filtros IN/NOT IN) */
private static $advancedReport = false;

/** @var array */
/** @var array filtros añadidos en tiempo de ejecución mediante addCustomFilter(), no se persisten en base de datos */
private $customFilters = [];

/** @var array */
/** @var array cláusulas JOIN en SQL crudo añadidas en tiempo de ejecución mediante addCustomJoin() */
private $customJoins = [];

/** @var string */
/** @var string fragmento de SQL crudo añadido mediante addCustomSql() cuando el modo avanzado está activo */
private $customSql = '';

/** @var string */
/** @var string alias usado para la columna X en los resultados, sobrescrito mediante addFieldXName() */
private $fieldXName;

public function addFieldXName(string $name): void
Expand Down
26 changes: 13 additions & 13 deletions Model/ReportAmount.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,43 +33,43 @@ class ReportAmount extends ModelClass
{
use ModelTrait;

/** @var int */
/** @var int canal de la empresa a incluir en el informe */
public $channel;

/** @var string */
/** @var string subcuenta final del rango a incluir */
public $endcodsubaccount;

/** @var string */
/** @var string fecha final del periodo del informe */
public $enddate;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id de la empresa del informe */
public $idcompany;

/** @var bool */
/** @var bool si se ignoran los asientos de cierre */
public $ignoreclosure;

/** @var bool */
/** @var bool si se ignora el asiento de apertura */
public $ignore_opening;

/** @var bool */
/** @var bool si se ignoran los asientos de regularización */
public $ignoreregularization;

/** @var int */
/** @var int nivel de detalle de las subcuentas a mostrar */
public $level;

/** @var string */
/** @var string nombre del informe */
public $name;

/** @var bool */
/** @var bool si se muestra el saldo de apertura */
public $show_balance_opening;

/** @var string */
/** @var string subcuenta inicial del rango a incluir */
public $startcodsubaccount;

/** @var string */
/** @var string fecha inicial del periodo del informe */
public $startdate;

public function clear(): void
Expand Down
18 changes: 9 additions & 9 deletions Model/ReportBalance.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,31 @@ class ReportBalance extends ModelClass
const SUBTYPE_NORMAL = 'normal';
const SUBTYPE_PYMES = 'pymes';

/** @var int */
/** @var int canal de la empresa a incluir en el informe */
public $channel;

/** @var bool */
/** @var bool si se muestra el balance comparativo con el periodo anterior */
public $comparative;

/** @var string */
/** @var string fecha final del periodo del informe */
public $enddate;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id de la empresa del informe */
public $idcompany;

/** @var string */
/** @var string nombre del informe */
public $name;

/** @var string */
/** @var string fecha inicial del periodo del informe */
public $startdate;

/** @var string */
/** @var string tipo de balance: balance-sheet, profit-and-loss o income-and-expenses */
public $type;

/** @var string */
/** @var string subtipo de balance: abbreviated, normal o pymes */
public $subtype;

public function clear(): void
Expand Down
10 changes: 5 additions & 5 deletions Model/ReportBoard.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ class ReportBoard extends ModelClass
{
use ModelTrait;

/** @var string */
/** @var string fecha y hora de creación */
public $creationdate;

/** @var bool */
/** @var bool si el tablero aparece destacado */
public $featured;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var string */
/** @var string nombre del tablero */
public $name;

/** @var string */
/** @var string etiqueta usada para agrupar tableros */
public $tag;

public function addLine(Report $report, int $pos = 1): bool
Expand Down
12 changes: 6 additions & 6 deletions Model/ReportBoardLine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,22 @@ class ReportBoardLine extends ModelClass
{
use ModelTrait;

/** @var int */
/** @var int número de columnas que ocupa el informe en el tablero */
public $columns;

/** @var int */
/** @var int alto en píxeles del informe en el tablero */
public $height;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id del informe mostrado en esta línea */
public $idreport;

/** @var int */
/** @var int id del tablero al que pertenece esta línea */
public $idreportboard;

/** @var int */
/** @var int posición de la línea dentro del tablero */
public $sort;

public function clear(): void
Expand Down
14 changes: 7 additions & 7 deletions Model/ReportBoardUser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,25 @@ class ReportBoardUser extends ModelClass
{
use ModelTrait;

/** @var string */
/** @var string fecha y hora de creación */
public $creation_date;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id del tablero asociado */
public $id_report_board;

/** @var string */
/** @var string nick del último usuario que modificó el registro */
public $last_nick;

/** @var string */
/** @var string fecha y hora de la última modificación */
public $last_update;

/** @var string */
/** @var string nick del usuario que creó el registro */
public $nick;

/** @var string */
/** @var string nick del usuario al que se asigna el tablero */
public $user_nick;

public function getReportBoard(): DinReportBoard
Expand Down
10 changes: 5 additions & 5 deletions Model/ReportFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ class ReportFilter extends ModelClass
{
use ModelTrait;

/** @var int */
/** @var int clave primaria */
public $id;

/** @var int */
/** @var int id del informe al que pertenece el filtro */
public $id_report;

/** @var string */
/** @var string operador de comparación (=, !=, >, <, IN, NOT IN, IS NULL...) */
public $operator;

/** @var string */
/** @var string columna (con su tabla) sobre la que se aplica el filtro */
public $table_column;

/** @var string */
/** @var string valor de comparación del filtro, puede ser un valor dinámico como {today} */
public $value;

public static function getDynamicValue(string $value): string
Expand Down
Loading