diff --git a/Model/BalanceAccount.php b/Model/BalanceAccount.php index c62678b..bc50aff 100644 --- a/Model/BalanceAccount.php +++ b/Model/BalanceAccount.php @@ -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 diff --git a/Model/BalanceCode.php b/Model/BalanceCode.php index f0f86fb..fa022eb 100644 --- a/Model/BalanceCode.php +++ b/Model/BalanceCode.php @@ -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 diff --git a/Model/Report.php b/Model/Report.php index 91d68c7..927e72a 100644 --- a/Model/Report.php +++ b/Model/Report.php @@ -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 diff --git a/Model/ReportAmount.php b/Model/ReportAmount.php index 4bdcd1c..dd239cc 100644 --- a/Model/ReportAmount.php +++ b/Model/ReportAmount.php @@ -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 diff --git a/Model/ReportBalance.php b/Model/ReportBalance.php index 8a57bf2..ba181d9 100644 --- a/Model/ReportBalance.php +++ b/Model/ReportBalance.php @@ -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 diff --git a/Model/ReportBoard.php b/Model/ReportBoard.php index b83c5ef..e9cae06 100644 --- a/Model/ReportBoard.php +++ b/Model/ReportBoard.php @@ -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 diff --git a/Model/ReportBoardLine.php b/Model/ReportBoardLine.php index b4f93a2..381530a 100644 --- a/Model/ReportBoardLine.php +++ b/Model/ReportBoardLine.php @@ -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 diff --git a/Model/ReportBoardUser.php b/Model/ReportBoardUser.php index cea7579..842c2d1 100644 --- a/Model/ReportBoardUser.php +++ b/Model/ReportBoardUser.php @@ -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 diff --git a/Model/ReportFilter.php b/Model/ReportFilter.php index 3481370..a0e33c8 100644 --- a/Model/ReportFilter.php +++ b/Model/ReportFilter.php @@ -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 diff --git a/Model/ReportLedger.php b/Model/ReportLedger.php index 5749084..29aa9b3 100644 --- a/Model/ReportLedger.php +++ b/Model/ReportLedger.php @@ -33,37 +33,37 @@ class ReportLedger 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 número de asiento final del rango a incluir */ public $endentry; - /** @var bool */ + /** @var bool si se agrupan los apuntes */ public $groupingtype; - /** @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 subcuenta inicial del rango a incluir */ public $startcodsubaccount; - /** @var string */ + /** @var string fecha inicial del periodo del informe */ public $startdate; - /** @var int */ + /** @var int número de asiento inicial del rango a incluir */ public $startentry; public function clear(): void