A free open source IT asset/license management system
Labels: refactor buildLayout into trait
Godfrey Mc206afddb5c3
diff --git a/app/Models/Labels/CustomLabels/Concerns/BuildsCustomLabelLayout.php b/app/Models/Labels/CustomLabels/Concerns/BuildsCustomLabelLayout.phpnew file mode 100644index 0000000000..9ef4a5f714--- /dev/null+++ b/app/Models/Labels/CustomLabels/Concerns/BuildsCustomLabelLayout.php@@ -0,0 +1,117 @@+<?php++namespace App\Models\Labels\CustomLabels\Concerns;++trait BuildsCustomLabelLayout+{+ protected function baseLayout($pa): array+ {+ return [+ 'printable' => $this->boxFromPrintableArea($pa),+ 'body' => $this->boxFromPrintableArea($pa),+ 'barcode1d' => null,+ 'barcode2d' => null,+ 'logo' => null,+ 'tag' => null,+ 'text' => null,+ 'title' => null,+ 'fields' => null,+ ];+ }++ protected function boxFromPrintableArea($pa): array+ {+ return [+ 'x1' => $pa->x1,+ 'y1' => $pa->y1,+ 'x2' => $pa->x2,+ 'y2' => $pa->y2,+ 'w' => $pa->w,+ 'h' => $pa->h,+ ];+ }++ protected function resolveLayoutTitle($record): ?string+ {+ return $record->has('title') && $this->getSupportTitle()+ ? $record->get('title')+ : null;+ }++ protected function resolveLayoutFields($record): array+ {+ if (!$record->has('fields') || !$this->getSupportFields()) {+ return [];+ }++ return collect($record->get('fields'))+ ->take($this->getSupportFields())+ ->values()+ ->all();+ }++ protected function applyTextAreaConstraints(array $textBox): array+ {+ if ($this->getTextAreaWidth() !== null) {+ $textBox['w'] = min($this->getTextAreaWidth(), $textBox['w']);+ $textBox['x2'] = $textBox['x1'] + $textBox['w'];+ }++ if ($this->getTextAreaHeight() !== null) {+ $textBox['h'] = min($this->getTextAreaHeight(), $textBox['h']);+ $textBox['y2'] = $textBox['y1'] + $textBox['h'];+ }++ return $textBox;+ }++ protected function applySimpleTitleLayout(array $layout, ?string $title, float &$textY): array+ {+ if ($title === null || $title === '') {+ return $layout;+ }++ $x = $layout['text']['x1'] + $this->getTitleOffsetX();++ $layout['title'] = [+ 'x' => $x,+ 'y' => $textY,+ 'w' => max(0, $layout['text']['x2'] - $x),+ 'h' => $this->getTitleSize(),+ 'font_size' => $this->getTitleSize(),+ 'advance' => $this->getTitleSize() + $this->getTitleMargin(),+ ];++ $textY += $layout['title']['advance'];++ return $layout;+ }++ protected function makeFieldsLayout(+ array $textBox,+ array $fields,+ float $textY,+ float $bottomLimit,+ float $labelWidth,+ float $valueGap,+ float $labelSize,+ float $fieldSize,+ float $rowAdvance,+ ): array+ {+ $valueX = $textBox['x1'] + $labelWidth + $valueGap;++ return [+ 'start_x' => $textBox['x1'],+ 'start_y' => $textY,+ 'bottom_limit' => $bottomLimit,+ 'label_width' => $labelWidth,+ 'value_x' => $valueX,+ 'value_width' => max(0, $textBox['x2'] - $valueX),+ 'label_size' => $labelSize,+ 'field_size' => $fieldSize,+ 'row_advance' => $rowAdvance,+ 'fields' => $fields,+ ];+ }+}\ No newline at end of filediff --git a/app/Models/Labels/CustomLabels/CustomSheetLabel.php b/app/Models/Labels/CustomLabels/CustomSheetLabel.phpindex 3b15464292..8a94035f48 100644--- a/app/Models/Labels/CustomLabels/CustomSheetLabel.php+++ b/app/Models/Labels/CustomLabels/CustomSheetLabel.php@@ -3,6 +3,7 @@namespace App\Models\Labels\CustomLabels;use App\Helpers\Helper;+use App\Models\Labels\CustomLabels\Concerns\BuildsCustomLabelLayout;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelContentProperties;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelEditorConfig;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelSupports;@@ -19,6 +20,7 @@ abstract class CustomSheetLabel extends RectangleSheet}use HasCustomLabelSupports;use SeedsCustomLabelFromTemplate;+ use BuildsCustomLabelLayout;protected array $editorConfig = [];protected string $unit = 'mm';@@ -218,7 +220,6 @@ abstract class CustomSheetLabel extends RectangleSheetpublic function write($pdf, $record){$pa = $this->getLabelPrintableArea();-$layout = $this->buildLayout($pdf, $record, $pa);$this->render1DBarcode($pdf, $record, $layout);@@ -230,31 +231,7 @@ abstract class CustomSheetLabel extends RectangleSheetprotected function buildLayout($pdf, $record, $pa): array{- $layout = [- 'printable' => [- 'x1' => $pa->x1,- 'y1' => $pa->y1,- 'x2' => $pa->x2,- 'y2' => $pa->y2,- 'w' => $pa->w,- 'h' => $pa->h,- ],- 'body' => [- 'x1' => $pa->x1,- 'y1' => $pa->y1,- 'x2' => $pa->x2,- 'y2' => $pa->y2,- 'w' => $pa->w,- 'h' => $pa->h,- ],- 'barcode1d' => null,- 'barcode2d' => null,- 'logo' => null,- 'tag' => null,- 'text' => null,- 'title' => null,- 'fields' => null,- ];+ $layout = $this->baseLayout($pa);/*|--------------------------------------------------------------------------@@ -311,32 +288,10 @@ abstract class CustomSheetLabel extends RectangleSheet| Title + fields inside text box|--------------------------------------------------------------------------*/- $title = null;- if ($record->has('title') && $this->getSupportTitle()) {- $title = $record->get('title');- }-- $fields = [];- if ($record->has('fields') && $this->getSupportFields()) {- $fields = collect($record->get('fields'))- ->take($this->getSupportFields())- ->values()- ->all();- }-- $textBox = $layout['text'];-- if ($this->getTextAreaWidth() !== null) {- $textBox['w'] = min($this->getTextAreaWidth(), $textBox['w']);- $textBox['x2'] = $textBox['x1'] + $textBox['w'];- }+ $title = $this->resolveLayoutTitle($record);+ $fields = $this->resolveLayoutFields($record);- if ($this->getTextAreaHeight() !== null) {- $textBox['h'] = min($this->getTextAreaHeight(), $textBox['h']);- $textBox['y2'] = $textBox['y1'] + $textBox['h'];- }-- $layout['text'] = $textBox;+ $layout['text'] = $this->applyTextAreaConstraints($layout['text']);$textY = $layout['text']['y1'];$bottomLimit = $layout['text']['y2'];$availableHeight = max(0, $bottomLimit - $textY);@@ -359,6 +314,7 @@ abstract class CustomSheetLabel extends RectangleSheetif ($fieldLayout['hasTitle']) {$x = $layout['text']['x1'] + $this->getTitleOffsetX();+$layout['title'] = ['x' => $x,'y' => $textY,@@ -373,21 +329,18 @@ abstract class CustomSheetLabel extends RectangleSheet$labelWidth = min($fieldLayout['labelWidth'], $layout['text']['w'] * 0.45);$gap = max(0.8, $this->getFieldMargin() * max($fieldLayout['scale'], 0.5));- $valueX = $layout['text']['x1'] + $labelWidth + $gap;- $valueWidth = max(0, $layout['text']['x2'] - $valueX);-- $layout['fields'] = [- 'start_x' => $layout['text']['x1'],- 'start_y' => $textY,- 'bottom_limit' => $bottomLimit,- 'label_width' => $labelWidth,- 'value_x' => $valueX,- 'value_width' => $valueWidth,- 'label_size' => $fieldLayout['labelSize'],- 'field_size' => $fieldLayout['fieldSize'],- 'row_advance' => $fieldLayout['rowAdvance'],- 'fields' => $fields,- ];++ $layout['fields'] = $this->makeFieldsLayout(+ $layout['text'],+ $fields,+ $textY,+ $bottomLimit,+ $labelWidth,+ $gap,+ $fieldLayout['labelSize'],+ $fieldLayout['fieldSize'],+ $fieldLayout['rowAdvance'],+ );return $layout;}diff --git a/app/Models/Labels/CustomLabels/CustomTapeLabel.php b/app/Models/Labels/CustomLabels/CustomTapeLabel.phpindex d295cf0239..475f0f3b2a 100644--- a/app/Models/Labels/CustomLabels/CustomTapeLabel.php+++ b/app/Models/Labels/CustomLabels/CustomTapeLabel.php@@ -2,6 +2,7 @@namespace App\Models\Labels\CustomLabels;+use App\Models\Labels\CustomLabels\Concerns\BuildsCustomLabelLayout;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelContentProperties;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelEditorConfig;use App\Models\Labels\CustomLabels\Concerns\HasCustomLabelSupports;@@ -19,6 +20,7 @@ abstract class CustomTapeLabel extends Labeluse HasCustomLabelSupports;use HasCustomLabelContentProperties;use SeedsCustomLabelFromTemplate;+ use BuildsCustomLabelLayout;protected array $editorConfig = [];protected string $unit = 'mm';@@ -205,7 +207,6 @@ abstract class CustomTapeLabel extends Labelpublic function write($pdf, $record){$pa = $this->getPrintableArea();-$layout = $this->buildLayout($pdf, $record, $pa);$this->render1DBarcode($pdf, $record, $layout);@@ -217,31 +218,7 @@ abstract class CustomTapeLabel extends Labelprotected function buildLayout($pdf, $record, $pa): array{- $layout = [- 'printable' => [- 'x1' => $pa->x1,- 'y1' => $pa->y1,- 'x2' => $pa->x2,- 'y2' => $pa->y2,- 'w' => $pa->w,- 'h' => $pa->h,- ],- 'body' => [- 'x1' => $pa->x1,- 'y1' => $pa->y1,- 'x2' => $pa->x2,- 'y2' => $pa->y2,- 'w' => $pa->w,- 'h' => $pa->h,- ],- 'barcode1d' => null,- 'barcode2d' => null,- 'logo' => null,- 'tag' => null,- 'text' => null,- 'title' => null,- 'fields' => null,- ];+ $layout = $this->baseLayout($pa);/*|--------------------------------------------------------------------------@@ -365,45 +342,17 @@ abstract class CustomTapeLabel extends Label| Title + fields|--------------------------------------------------------------------------*/- $title = null;-- if ($record->has('title') && $this->getSupportTitle()) {- $title = $record->get('title');- }-- $fields = [];+ $title = $this->resolveLayoutTitle($record);+ $fields = $this->resolveLayoutFields($record);- if ($record->has('fields') && $this->getSupportFields()) {- $fields = collect($record->get('fields'))- ->take($this->getSupportFields())- ->values()- ->all();- }-- $textBox = $layout['text'];-- if ($this->getTextAreaWidth() !== null) {- $textBox['w'] = min($this->getTextAreaWidth(), $textBox['w']);- $textBox['x2'] = $textBox['x1'] + $textBox['w'];- }-- if ($this->getTextAreaHeight() !== null) {- $textBox['h'] = min($this->getTextAreaHeight(), $textBox['h']);- $textBox['y2'] = $textBox['y1'] + $textBox['h'];- }-- $layout['text'] = $textBox;+ $layout['text'] = $this->applyTextAreaConstraints($layout['text']);if ($this->getTextAreaOffsetY() !== 0.0) {$layout['text']['y2'] += $this->getTextAreaOffsetY();$layout['text']['h'] = max(0, $layout['text']['y2'] - $layout['text']['y1']);}- if (- $useTextColumnBarcode &&- $record->has('barcode1d') &&- $this->getSupport1DBarcode()- ) {+ if ($useTextColumnBarcode && $record->has('barcode1d') && $this->getSupport1DBarcode()) {$barcodeHeight = min(max(0, $this->getBarcodeSize()),$layout['text']['h']@@ -419,51 +368,31 @@ abstract class CustomTapeLabel extends Label$layout['text']['y2'] -= $barcodeHeight;$layout['text']['h'] = max(0, $layout['text']['y2'] - $layout['text']['y1']);}+$textY = $layout['text']['y1'];$bottomLimit = $layout['text']['y2'];-- $hasTitle = $title !== null && $title !== '';-- if ($hasTitle) {- $x = $layout['text']['x1'] + $this->getTitleOffsetX();-- $layout['title'] = [- 'x' => $x,- 'y' => $textY,- 'w' => max(0, $layout['text']['x2'] - $x),- 'h' => $this->getTitleSize(),- 'font_size' => $this->getTitleSize(),- 'advance' => $this->getTitleSize() + $this->getTitleMargin(),- ];-- $textY += $layout['title']['advance'];- }+ $layout = $this->applySimpleTitleLayout($layout, $title, $textY);$labelWidth = min($this->measureTapeLabelWidth($pdf, $fields),$layout['text']['w'] * 0.45);- $gap = max(0, $this->getFieldMargin());- $valueX = $layout['text']['x1'] + $labelWidth + $gap;- $valueWidth = max(0, $layout['text']['x2'] - $valueX);-- $layout['fields'] = [- 'start_x' => $layout['text']['x1'],- 'start_y' => $textY,- 'bottom_limit' => $bottomLimit,- 'label_width' => $labelWidth,- 'value_x' => $valueX,- 'value_width' => $valueWidth,- 'label_size' => $this->getLabelSize(),- 'field_size' => $this->getFieldSize(),- 'row_advance' => $this->getLabelSize()- + $this->getLabelMargin()- + $this->getFieldSize()- + $this->getFieldMargin(),- 'fields' => $fields,- ];+ $layout['fields'] = $this->makeFieldsLayout(+ $layout['text'],+ $fields,+ $textY,+ $bottomLimit,+ $labelWidth,+ max(0, $this->getFieldMargin()),+ $this->getLabelSize(),+ $this->getFieldSize(),+ $this->getLabelSize()+ + $this->getLabelMargin()+ + $this->getFieldSize()+ + $this->getFieldMargin(),+ );return $layout;}