Skip to content

Commit 45ee15c

Browse files
Denis-AverinDenis-Averin
authored
Release 20.12 (#6)
1 parent 3120bd0 commit 45ee15c

21 files changed

+705
-29
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Aspose.BarCode Cloud SDK for PHP
22

33
- API version: 3.0
4-
- Package version: 20.11.0
4+
- Package version: 20.12.0
55

66
Aspose.BarCode for Cloud is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.
77

@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
140140
- [GeneratorParamsList](docs/Model/GeneratorParamsList.md)
141141
- [ITF14BorderType](docs/Model/ITF14BorderType.md)
142142
- [ITFParams](docs/Model/ITFParams.md)
143+
- [MacroCharacter](docs/Model/MacroCharacter.md)
143144
- [MaxiCodeParams](docs/Model/MaxiCodeParams.md)
144145
- [ObjectExist](docs/Model/ObjectExist.md)
145146
- [Padding](docs/Model/Padding.md)
@@ -160,6 +161,7 @@ Class | Method | HTTP request | Description
160161
- [ResultImageInfo](docs/Model/ResultImageInfo.md)
161162
- [StorageExist](docs/Model/StorageExist.md)
162163
- [StorageFile](docs/Model/StorageFile.md)
164+
- [StructuredAppend](docs/Model/StructuredAppend.md)
163165
- [TextAlignment](docs/Model/TextAlignment.md)
164166
- [FileVersion](docs/Model/FileVersion.md)
165167

‎docs/Api/BarcodeApi.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Method | HTTP request | Description
1414

1515

1616
# **getBarcodeGenerate**
17-
> \SplFileObject getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format)
17+
> \SplFileObject getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format)
1818
1919
Generate barcode.
2020

@@ -39,6 +39,7 @@ $text_location = "text_location_example"; // string | Specify the displaying Tex
3939
$text_alignment = "text_alignment_example"; // string | Text alignment.
4040
$text_color = "text_color_example"; // string | Specify the displaying CodeText's Color. Default value: Color.Black.
4141
$font_size_mode = "font_size_mode_example"; // string | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
42+
$no_wrap = true; // bool | Specify word wraps (line breaks) within text. Default value: false.
4243
$resolution = 1.2; // double | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
4344
$resolution_x = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
4445
$resolution_y = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
@@ -68,7 +69,7 @@ $bar_width_reduction = 1.2; // double | Bars reduction value that is used to com
6869
$format = "format_example"; // string | Result image format.
6970

7071
try {
71-
$result = $apiInstance->getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format);
72+
$result = $apiInstance->getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format);
7273
print_r($result);
7374
} catch (Exception $e) {
7475
echo 'Exception when calling BarcodeApi->getBarcodeGenerate: ', $e->getMessage(), PHP_EOL;
@@ -87,6 +88,7 @@ Name | Type | Description | Notes
8788
**text_alignment** | **string**| Text alignment. | [optional]
8889
**text_color** | **string**| Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
8990
**font_size_mode** | **string**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
91+
**no_wrap** | **bool**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
9092
**resolution** | **double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
9193
**resolution_x** | **double**| DEPRECATED: Use 'Resolution' instead. | [optional]
9294
**resolution_y** | **double**| DEPRECATED: Use 'Resolution' instead. | [optional]
@@ -420,7 +422,7 @@ Name | Type | Description | Notes
420422
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
421423

422424
# **putBarcodeGenerateFile**
423-
> \Aspose\BarCode\Model\ResultImageInfo putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format)
425+
> \Aspose\BarCode\Model\ResultImageInfo putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format)
424426
425427
Generate barcode and save on server (from query params or from file with json or xml content)
426428

@@ -446,6 +448,7 @@ $text_location = "text_location_example"; // string | Specify the displaying Tex
446448
$text_alignment = "text_alignment_example"; // string | Text alignment.
447449
$text_color = "text_color_example"; // string | Specify the displaying CodeText's Color. Default value: Color.Black.
448450
$font_size_mode = "font_size_mode_example"; // string | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
451+
$no_wrap = true; // bool | Specify word wraps (line breaks) within text. Default value: false.
449452
$resolution = 1.2; // double | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
450453
$resolution_x = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
451454
$resolution_y = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
@@ -477,7 +480,7 @@ $folder = "folder_example"; // string | Image's folder.
477480
$format = "format_example"; // string | The image format.
478481

479482
try {
480-
$result = $apiInstance->putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format);
483+
$result = $apiInstance->putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format);
481484
print_r($result);
482485
} catch (Exception $e) {
483486
echo 'Exception when calling BarcodeApi->putBarcodeGenerateFile: ', $e->getMessage(), PHP_EOL;
@@ -497,6 +500,7 @@ Name | Type | Description | Notes
497500
**text_alignment** | **string**| Text alignment. | [optional]
498501
**text_color** | **string**| Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
499502
**font_size_mode** | **string**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
503+
**no_wrap** | **bool**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
500504
**resolution** | **double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
501505
**resolution_x** | **double**| DEPRECATED: Use 'Resolution' instead. | [optional]
502506
**resolution_y** | **double**| DEPRECATED: Use 'Resolution' instead. | [optional]

‎docs/Model/CaptionParams.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**visible** | **bool** | Is caption visible. | [optional]
1010
**font** | [**\Aspose\BarCode\Model\FontParams**](FontParams.md) | Font. | [optional]
1111
**padding** | [**\Aspose\BarCode\Model\Padding**](Padding.md) | Padding. | [optional]
12+
**no_wrap** | **bool** | Specify word wraps (line breaks) within text. Default value: false. | [optional]
1213

1314
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1415

‎docs/Model/DataBarParams.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
66
**aspect_ratio** | **double** | Height/Width ratio of 2D BarCode module. Used for DataBar stacked. | [optional]
77
**columns** | **int** | Columns count. | [optional]
88
**rows** | **int** | Rows count. | [optional]
9+
**is2_d_composite_component** | **bool** | Enables flag of 2D composite component with DataBar barcode | [optional]
10+
**is_allow_only_gs1_encoding** | **bool** | If this flag is set, it allows only GS1 encoding standard for Databar barcode types | [optional]
911

1012
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1113

‎docs/Model/DataMatrixParams.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**data_matrix_ecc** | [**\Aspose\BarCode\Model\DataMatrixEccType**](DataMatrixEccType.md) | Datamatrix ECC type. Default value: DataMatrixEccType.Ecc200. | [optional]
1010
**data_matrix_encode_mode** | [**\Aspose\BarCode\Model\DataMatrixEncodeMode**](DataMatrixEncodeMode.md) | Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.Auto. | [optional]
1111
**rows** | **int** | Rows count. | [optional]
12+
**macro_characters** | [**\Aspose\BarCode\Model\MacroCharacter**](MacroCharacter.md) | Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with DataMatrixEccType.Ecc200 or DataMatrixEccType.EccAuto. Cannot be used with EncodeTypes.GS1DataMatrix Default value: MacroCharacters.None. | [optional]
1213

1314
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1415

‎docs/Model/GeneratorParams.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**text_color** | **string** | Specify the displaying CodeText's Color. Default value: Color.Black. | [optional]
1212
**font** | [**\Aspose\BarCode\Model\FontParams**](FontParams.md) | Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto. | [optional]
1313
**font_size_mode** | [**\Aspose\BarCode\Model\FontMode**](FontMode.md) | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
14+
**no_wrap** | **bool** | Specify word wraps (line breaks) within text. Default value: false. | [optional]
1415
**resolution** | **double** | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
1516
**resolution_x** | **double** | DEPRECATED: Use 'Resolution' instead. | [optional]
1617
**resolution_y** | **double** | DEPRECATED: Use 'Resolution' instead. | [optional]

‎docs/Model/MacroCharacter.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# MacroCharacter
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
8+
9+

‎docs/Model/QrParams.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**encode_mode** | [**\Aspose\BarCode\Model\QREncodeMode**](QREncodeMode.md) | QR symbology type of BarCode's encoding mode. Default value: QREncodeMode.Auto. | [optional]
1111
**error_level** | [**\Aspose\BarCode\Model\QRErrorLevel**](QRErrorLevel.md) | Level of Reed-Solomon error correction for QR barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see QRErrorLevel. | [optional]
1212
**version** | [**\Aspose\BarCode\Model\QRVersion**](QRVersion.md) | Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.Auto. | [optional]
13+
**structured_append** | [**\Aspose\BarCode\Model\StructuredAppend**](StructuredAppend.md) | QR structured append parameters. | [optional]
1314

1415
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1516

‎docs/Model/StructuredAppend.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# StructuredAppend
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**sequence_indicator** | **int** | The index of the QR structured append mode barcode. Index starts from 0. | [optional]
7+
**total_count** | **int** | Gets or sets the QR structured append mode barcodes quantity. Max value is 16. | [optional]
8+
**parity_byte** | **int** | Gets or sets the QR structured append mode parity data. | [optional]
9+
10+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
11+
12+

‎src/Aspose/BarCode/BarcodeApi.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,16 @@ protected function GetBarcodeGenerateRequest(Requests\GetBarcodeGenerateRequest
352352
}
353353
}
354354
// query params
355+
if (isset($request->no_wrap)) {
356+
$localName = lcfirst('NoWrap');
357+
$localValue = is_bool($request->no_wrap) ? ($request->no_wrap ? 'true' : 'false') : $request->no_wrap;
358+
if (strpos($resourcePath, '{' . $localName . '}') !== false) {
359+
$resourcePath = str_replace('{' . $localName . '}', ObjectSerializer::toPathValue($localValue), $resourcePath);
360+
} else {
361+
$queryParams[$localName] = ObjectSerializer::toQueryValue($localValue);
362+
}
363+
}
364+
// query params
355365
if (isset($request->resolution)) {
356366
$localName = lcfirst('Resolution');
357367
$localValue = is_bool($request->resolution) ? ($request->resolution ? 'true' : 'false') : $request->resolution;
@@ -2458,6 +2468,16 @@ protected function PutBarcodeGenerateFileRequest(Requests\PutBarcodeGenerateFile
24582468
}
24592469
}
24602470
// query params
2471+
if (isset($request->no_wrap)) {
2472+
$localName = lcfirst('NoWrap');
2473+
$localValue = is_bool($request->no_wrap) ? ($request->no_wrap ? 'true' : 'false') : $request->no_wrap;
2474+
if (strpos($resourcePath, '{' . $localName . '}') !== false) {
2475+
$resourcePath = str_replace('{' . $localName . '}', ObjectSerializer::toPathValue($localValue), $resourcePath);
2476+
} else {
2477+
$queryParams[$localName] = ObjectSerializer::toQueryValue($localValue);
2478+
}
2479+
}
2480+
// query params
24612481
if (isset($request->resolution)) {
24622482
$localName = lcfirst('Resolution');
24632483
$localValue = is_bool($request->resolution) ? ($request->resolution ? 'true' : 'false') : $request->resolution;

0 commit comments

Comments
 (0)