Skip to content

Commit 8a0054f

Browse files
ivankamkinivankamkin
authored
Group generate params (#106)
* Code regenerate with new templates. Build and tests fixed. Fixed linter errors * Fix snippets
1 parent 6448ce1 commit 8a0054f

66 files changed

Lines changed: 828 additions & 711 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,4 @@ format-doc:
3535
.PHONY: after-gen
3636
after-gen: format insert-example format-doc
3737
./scripts/add-deprecation-warnings.bash
38+
./scripts/add-screaming-snake-enum-aliases.bash

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ require __DIR__ . '/vendor/autoload.php';
6666
use Aspose\BarCode\Configuration;
6767
use Aspose\BarCode\GenerateApi;
6868
use Aspose\BarCode\Requests\GenerateRequestWrapper;
69-
use Aspose\BarCode\Model\{EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QREncodeMode, QRErrorLevel, QRVersion};
69+
use Aspose\BarCode\Model\{BarcodeImageParams, EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QrParams, QREncodeMode, QRErrorLevel, QRVersion};
7070

7171
$config = new Configuration();
7272
$config->setClientId('ClientId from https://dashboard.aspose.cloud/applications');
@@ -76,12 +76,14 @@ if (getenv("TEST_CONFIGURATION_ACCESS_TOKEN")) {
7676
}
7777

7878
$request = new GenerateRequestWrapper(EncodeBarcodeType::QR, 'PHP SDK Test');
79-
$request->image_format = BarcodeImageFormat::Png;
80-
$request->text_location = CodeLocation::None;
81-
$request->qr_encode_mode = QREncodeMode::Auto;
82-
$request->qr_error_level = QRErrorLevel::LevelM;
83-
$request->qr_version = QRVersion::Auto;
84-
$request->qr_aspect_ratio = 0.75;
79+
$request->barcode_image_params = new BarcodeImageParams();
80+
$request->barcode_image_params->setImageFormat(BarcodeImageFormat::Png);
81+
$request->barcode_image_params->setTextLocation(CodeLocation::None);
82+
$request->qr_params = new QrParams();
83+
$request->qr_params->setQrEncodeMode(QREncodeMode::Auto);
84+
$request->qr_params->setQrErrorLevel(QRErrorLevel::LevelM);
85+
$request->qr_params->setQrVersion(QRVersion::Auto);
86+
$request->qr_params->setQrAspectRatio(0.75);
8587

8688
$api = new GenerateApi(null, $config);
8789
$response = $api->generate($request);

‎docs/Api/GenerateApi.md‎

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

‎docs/Api/RecognizeApi.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ $apiInstance = new Aspose\BarCode\Api\RecognizeApi(
3636
new GuzzleHttp\Client(),
3737
$config
3838
);
39-
$barcode_type = new \Aspose\BarCode\Model\DecodeBarcodeType(); // \Aspose\BarCode\Model\DecodeBarcodeType | Type of barcode to recognize.
39+
$barcode_type = new \Aspose\BarCode\Model\\AsposeBarCodeModelDecodeBarcodeType(); // \AsposeBarCodeModelDecodeBarcodeType | Type of barcode to recognize.
4040
$file_url = 'file_url_example'; // string | URL to the barcode image.
41-
$recognition_mode = new \Aspose\BarCode\Model\RecognitionMode(); // \Aspose\BarCode\Model\RecognitionMode | Recognition mode.
42-
$recognition_image_kind = new \Aspose\BarCode\Model\RecognitionImageKind(); // \Aspose\BarCode\Model\RecognitionImageKind | Image kind for recognition.
41+
$recognition_mode = new \Aspose\BarCode\Model\\AsposeBarCodeModelRecognitionMode(); // \AsposeBarCodeModelRecognitionMode | Recognition mode.
42+
$recognition_image_kind = new \Aspose\BarCode\Model\\AsposeBarCodeModelRecognitionImageKind(); // \AsposeBarCodeModelRecognitionImageKind | Image kind for recognition.
4343

4444
try {
4545
$result = $apiInstance->recognize($barcode_type, $file_url, $recognition_mode, $recognition_image_kind);
@@ -53,10 +53,10 @@ try {
5353

5454
| Name | Type | Description | Notes |
5555
| ------------- | ------------- | ------------- | ------------- |
56-
| **barcode_type** | [**\Aspose\BarCode\Model\DecodeBarcodeType**](../Model/.md)| Type of barcode to recognize. | |
56+
| **barcode_type** | [**\AsposeBarCodeModelDecodeBarcodeType**](../Model/.md)| Type of barcode to recognize. | |
5757
| **file_url** | **string**| URL to the barcode image. | |
58-
| **recognition_mode** | [**\Aspose\BarCode\Model\RecognitionMode**](../Model/.md)| Recognition mode. | [optional] |
59-
| **recognition_image_kind** | [**\Aspose\BarCode\Model\RecognitionImageKind**](../Model/.md)| Image kind for recognition. | [optional] |
58+
| **recognition_mode** | [**\AsposeBarCodeModelRecognitionMode**](../Model/.md)| Recognition mode. | [optional] |
59+
| **recognition_image_kind** | [**\AsposeBarCodeModelRecognitionImageKind**](../Model/.md)| Image kind for recognition. | [optional] |
6060

6161
### Return type
6262

@@ -158,10 +158,10 @@ $apiInstance = new Aspose\BarCode\Api\RecognizeApi(
158158
new GuzzleHttp\Client(),
159159
$config
160160
);
161-
$barcode_type = new \Aspose\BarCode\Model\DecodeBarcodeType(); // \Aspose\BarCode\Model\DecodeBarcodeType
161+
$barcode_type = new \Aspose\BarCode\Model\DecodeBarcodeType(); // \Aspose\BarCode\Model\DecodeBarcodeType | See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/
162162
$file = '/path/to/file.txt'; // \SplFileObject | Barcode image file.
163-
$recognition_mode = new \Aspose\BarCode\Model\RecognitionMode(); // \Aspose\BarCode\Model\RecognitionMode
164-
$recognition_image_kind = new \Aspose\BarCode\Model\RecognitionImageKind(); // \Aspose\BarCode\Model\RecognitionImageKind
163+
$recognition_mode = new \Aspose\BarCode\Model\RecognitionMode(); // \Aspose\BarCode\Model\RecognitionMode | Recognition mode.
164+
$recognition_image_kind = new \Aspose\BarCode\Model\RecognitionImageKind(); // \Aspose\BarCode\Model\RecognitionImageKind | Image kind for recognition.
165165

166166
try {
167167
$result = $apiInstance->recognizeMultipart($barcode_type, $file, $recognition_mode, $recognition_image_kind);
@@ -175,10 +175,10 @@ try {
175175

176176
| Name | Type | Description | Notes |
177177
| ------------- | ------------- | ------------- | ------------- |
178-
| **barcode_type** | [**\Aspose\BarCode\Model\DecodeBarcodeType**](../Model/DecodeBarcodeType.md)| | |
178+
| **barcode_type** | [**\Aspose\BarCode\Model\DecodeBarcodeType**](../Model/DecodeBarcodeType.md)| See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ | |
179179
| **file** | **\SplFileObject****\SplFileObject**| Barcode image file. | |
180-
| **recognition_mode** | [**\Aspose\BarCode\Model\RecognitionMode**](../Model/RecognitionMode.md)| | [optional] |
181-
| **recognition_image_kind** | [**\Aspose\BarCode\Model\RecognitionImageKind**](../Model/RecognitionImageKind.md)| | [optional] |
180+
| **recognition_mode** | [**\Aspose\BarCode\Model\RecognitionMode**](../Model/RecognitionMode.md)| Recognition mode. | [optional] |
181+
| **recognition_image_kind** | [**\Aspose\BarCode\Model\RecognitionImageKind**](../Model/RecognitionImageKind.md)| Image kind for recognition. | [optional] |
182182

183183
### Return type
184184

‎docs/Model/ApiError.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**message** | **string** | Gets or sets error message. |
1010
**description** | **string** | Gets or sets error description. | [optional]
1111
**date_time** | **\DateTime** | Gets or sets server datetime. | [optional]
12-
**inner_error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | | [optional]
12+
**inner_error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | Gets or sets inner error. | [optional]
1313

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

‎docs/Model/ApiErrorResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ApiError Response
66
Name | Type | Description | Notes
77
---- | ---- | ----------- | -----
88
**request_id** | **string** | Gets or sets request Id. |
9-
**error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | |
9+
**error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | Gets or sets error. |
1010

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

‎docs/Model/BarcodeImageParams.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Optional barcode image parameters.
55
## Properties
66
Name | Type | Description | Notes
77
---- | ---- | ----------- | -----
8-
**image_format** | [**\Aspose\BarCode\Model\BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional]
9-
**text_location** | [**\Aspose\BarCode\Model\CodeLocation**](CodeLocation.md) | | [optional]
8+
**image_format** | [**\Aspose\BarCode\Model\BarcodeImageFormat**](BarcodeImageFormat.md) | Barcode output image format. Default value: png. | [optional] [default to BarcodeImageFormat::PNG]
9+
**text_location** | [**\Aspose\BarCode\Model\CodeLocation**](CodeLocation.md) | Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. | [optional]
1010
**foreground_color** | **string** | Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. | [optional] [default to 'Black']
1111
**background_color** | **string** | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. | [optional] [default to 'White']
12-
**units** | [**\Aspose\BarCode\Model\GraphicsUnit**](GraphicsUnit.md) | | [optional]
12+
**units** | [**\Aspose\BarCode\Model\GraphicsUnit**](GraphicsUnit.md) | Common units for all measurements. Default units: pixels. | [optional]
1313
**resolution** | **float** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional]
1414
**image_height** | **float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
1515
**image_width** | **float** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]

‎docs/Model/Code128Params.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Optional Code128 barcode generation parameters.
55
## Properties
66
Name | Type | Description | Notes
77
---- | ---- | ----------- | -----
8-
**code128_encode_mode** | [**\Aspose\BarCode\Model\Code128EncodeMode**](Code128EncodeMode.md) | | [optional]
8+
**code128_encode_mode** | [**\Aspose\BarCode\Model\Code128EncodeMode**](Code128EncodeMode.md) | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional]
99

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

‎docs/Model/EncodeData.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Data to encode in a barcode.
55
## Properties
66
Name | Type | Description | Notes
77
---- | ---- | ----------- | -----
8-
**data_type** | [**\Aspose\BarCode\Model\EncodeDataType**](EncodeDataType.md) | | [optional]
8+
**data_type** | [**\Aspose\BarCode\Model\EncodeDataType**](EncodeDataType.md) | Type of data to encode. Default value: StringData. | [optional] [default to EncodeDataType::STRING_DATA]
99
**data** | **string** | String that represents the data to encode. |
1010

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

‎docs/Model/GenerateParams.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Barcode generation parameters.
55
## Properties
66
Name | Type | Description | Notes
77
---- | ---- | ----------- | -----
8-
**barcode_type** | [**\Aspose\BarCode\Model\EncodeBarcodeType**](EncodeBarcodeType.md) | |
9-
**encode_data** | [**\Aspose\BarCode\Model\EncodeData**](EncodeData.md) | |
10-
**barcode_image_params** | [**\Aspose\BarCode\Model\BarcodeImageParams**](BarcodeImageParams.md) | | [optional]
11-
**qr_params** | [**\Aspose\BarCode\Model\QrParams**](QrParams.md) | | [optional]
12-
**code128_params** | [**\Aspose\BarCode\Model\Code128Params**](Code128Params.md) | | [optional]
13-
**pdf417_params** | [**\Aspose\BarCode\Model\Pdf417Params**](Pdf417Params.md) | | [optional]
8+
**barcode_type** | [**\Aspose\BarCode\Model\EncodeBarcodeType**](EncodeBarcodeType.md) | Barcode type. |
9+
**encode_data** | [**\Aspose\BarCode\Model\EncodeData**](EncodeData.md) | Data to encode into a barcode. |
10+
**barcode_image_params** | [**\Aspose\BarCode\Model\BarcodeImageParams**](BarcodeImageParams.md) | Optional barcode image parameters. | [optional]
11+
**qr_params** | [**\Aspose\BarCode\Model\QrParams**](QrParams.md) | Optional QR barcode generation parameters. | [optional]
12+
**code128_params** | [**\Aspose\BarCode\Model\Code128Params**](Code128Params.md) | Optional Code128 barcode generation parameters. | [optional]
13+
**pdf417_params** | [**\Aspose\BarCode\Model\Pdf417Params**](Pdf417Params.md) | Optional PDF417 barcode generation parameters. | [optional]
1414

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

0 commit comments

Comments
 (0)