Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ format-doc:
.PHONY: after-gen
after-gen: format insert-example format-doc
./scripts/add-deprecation-warnings.bash
./scripts/add-screaming-snake-enum-aliases.bash
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ require __DIR__ . '/vendor/autoload.php';
use Aspose\BarCode\Configuration;
use Aspose\BarCode\GenerateApi;
use Aspose\BarCode\Requests\GenerateRequestWrapper;
use Aspose\BarCode\Model\{EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QREncodeMode, QRErrorLevel, QRVersion};
use Aspose\BarCode\Model\{BarcodeImageParams, EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QrParams, QREncodeMode, QRErrorLevel, QRVersion};

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

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

$api = new GenerateApi(null, $config);
$response = $api->generate($request);
Expand Down
76 changes: 38 additions & 38 deletions docs/Api/GenerateApi.md

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/Api/RecognizeApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ $apiInstance = new Aspose\BarCode\Api\RecognizeApi(
new GuzzleHttp\Client(),
$config
);
$barcode_type = new \Aspose\BarCode\Model\DecodeBarcodeType(); // \Aspose\BarCode\Model\DecodeBarcodeType | Type of barcode to recognize.
$barcode_type = new \Aspose\BarCode\Model\\AsposeBarCodeModelDecodeBarcodeType(); // \AsposeBarCodeModelDecodeBarcodeType | Type of barcode to recognize.
$file_url = 'file_url_example'; // string | URL to the barcode image.
$recognition_mode = new \Aspose\BarCode\Model\RecognitionMode(); // \Aspose\BarCode\Model\RecognitionMode | Recognition mode.
$recognition_image_kind = new \Aspose\BarCode\Model\RecognitionImageKind(); // \Aspose\BarCode\Model\RecognitionImageKind | Image kind for recognition.
$recognition_mode = new \Aspose\BarCode\Model\\AsposeBarCodeModelRecognitionMode(); // \AsposeBarCodeModelRecognitionMode | Recognition mode.
$recognition_image_kind = new \Aspose\BarCode\Model\\AsposeBarCodeModelRecognitionImageKind(); // \AsposeBarCodeModelRecognitionImageKind | Image kind for recognition.

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

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

### Return type

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

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

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

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiError.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**message** | **string** | Gets or sets error message. |
**description** | **string** | Gets or sets error description. | [optional]
**date_time** | **\DateTime** | Gets or sets server datetime. | [optional]
**inner_error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | | [optional]
**inner_error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | Gets or sets inner error. | [optional]

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

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiErrorResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ApiError Response
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**request_id** | **string** | Gets or sets request Id. |
**error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | |
**error** | [**\Aspose\BarCode\Model\ApiError**](ApiError.md) | Gets or sets error. |

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

Expand Down
6 changes: 3 additions & 3 deletions docs/Model/BarcodeImageParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Optional barcode image parameters.
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**image_format** | [**\Aspose\BarCode\Model\BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional]
**text_location** | [**\Aspose\BarCode\Model\CodeLocation**](CodeLocation.md) | | [optional]
**image_format** | [**\Aspose\BarCode\Model\BarcodeImageFormat**](BarcodeImageFormat.md) | Barcode output image format. Default value: png. | [optional] [default to BarcodeImageFormat::PNG]
**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]
**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']
**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']
**units** | [**\Aspose\BarCode\Model\GraphicsUnit**](GraphicsUnit.md) | | [optional]
**units** | [**\Aspose\BarCode\Model\GraphicsUnit**](GraphicsUnit.md) | Common units for all measurements. Default units: pixels. | [optional]
**resolution** | **float** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional]
**image_height** | **float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
**image_width** | **float** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/Code128Params.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Optional Code128 barcode generation parameters.
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**code128_encode_mode** | [**\Aspose\BarCode\Model\Code128EncodeMode**](Code128EncodeMode.md) | | [optional]
**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]

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

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/EncodeData.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Data to encode in a barcode.
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**data_type** | [**\Aspose\BarCode\Model\EncodeDataType**](EncodeDataType.md) | | [optional]
**data_type** | [**\Aspose\BarCode\Model\EncodeDataType**](EncodeDataType.md) | Type of data to encode. Default value: StringData. | [optional] [default to EncodeDataType::STRING_DATA]
**data** | **string** | String that represents the data to encode. |

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
Expand Down
12 changes: 6 additions & 6 deletions docs/Model/GenerateParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Barcode generation parameters.
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**barcode_type** | [**\Aspose\BarCode\Model\EncodeBarcodeType**](EncodeBarcodeType.md) | |
**encode_data** | [**\Aspose\BarCode\Model\EncodeData**](EncodeData.md) | |
**barcode_image_params** | [**\Aspose\BarCode\Model\BarcodeImageParams**](BarcodeImageParams.md) | | [optional]
**qr_params** | [**\Aspose\BarCode\Model\QrParams**](QrParams.md) | | [optional]
**code128_params** | [**\Aspose\BarCode\Model\Code128Params**](Code128Params.md) | | [optional]
**pdf417_params** | [**\Aspose\BarCode\Model\Pdf417Params**](Pdf417Params.md) | | [optional]
**barcode_type** | [**\Aspose\BarCode\Model\EncodeBarcodeType**](EncodeBarcodeType.md) | Barcode type. |
**encode_data** | [**\Aspose\BarCode\Model\EncodeData**](EncodeData.md) | Data to encode into a barcode. |
**barcode_image_params** | [**\Aspose\BarCode\Model\BarcodeImageParams**](BarcodeImageParams.md) | Optional barcode image parameters. | [optional]
**qr_params** | [**\Aspose\BarCode\Model\QrParams**](QrParams.md) | Optional QR barcode generation parameters. | [optional]
**code128_params** | [**\Aspose\BarCode\Model\Code128Params**](Code128Params.md) | Optional Code128 barcode generation parameters. | [optional]
**pdf417_params** | [**\Aspose\BarCode\Model\Pdf417Params**](Pdf417Params.md) | Optional PDF417 barcode generation parameters. | [optional]

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

Expand Down
8 changes: 4 additions & 4 deletions docs/Model/Pdf417Params.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Optional PDF417 barcode generation parameters. Applies to Pdf417, MacroPdf417, M
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**pdf417_encode_mode** | [**\Aspose\BarCode\Model\Pdf417EncodeMode**](Pdf417EncodeMode.md) | | [optional]
**pdf417_error_level** | [**\Aspose\BarCode\Model\Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | | [optional]
**pdf417_encode_mode** | [**\Aspose\BarCode\Model\Pdf417EncodeMode**](Pdf417EncodeMode.md) | PDF417 barcode encode mode. | [optional]
**pdf417_error_level** | [**\Aspose\BarCode\Model\Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | PDF417 barcode error correction level. | [optional]
**pdf417_truncate** | **bool** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional]
**pdf417_columns** | **int** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional]
**pdf417_rows** | **int** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional]
**pdf417_aspect_ratio** | **float** | PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. | [optional]
**pdf417_eci_encoding** | [**\Aspose\BarCode\Model\ECIEncodings**](ECIEncodings.md) | | [optional]
**pdf417_eci_encoding** | [**\Aspose\BarCode\Model\ECIEncodings**](ECIEncodings.md) | ECI encoding for PDF417 barcode data. | [optional]
**pdf417_is_reader_initialization** | **bool** | Whether the barcode is used for reader initialization (programming). | [optional]
**pdf417_macro_characters** | [**\Aspose\BarCode\Model\MacroCharacter**](MacroCharacter.md) | | [optional]
**pdf417_macro_characters** | [**\Aspose\BarCode\Model\MacroCharacter**](MacroCharacter.md) | Macro character to prepend (structured append). | [optional]
**pdf417_is_linked** | **bool** | Whether to use linked mode (for MicroPdf417). | [optional]
**pdf417_is_code128_emulation** | **bool** | Whether to use Code128 emulation for MicroPdf417. | [optional]

Expand Down
12 changes: 6 additions & 6 deletions docs/Model/QrParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and Re
## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**qr_encode_mode** | [**\Aspose\BarCode\Model\QREncodeMode**](QREncodeMode.md) | | [optional]
**qr_error_level** | [**\Aspose\BarCode\Model\QRErrorLevel**](QRErrorLevel.md) | | [optional]
**qr_version** | [**\Aspose\BarCode\Model\QRVersion**](QRVersion.md) | | [optional]
**qr_eci_encoding** | [**\Aspose\BarCode\Model\ECIEncodings**](ECIEncodings.md) | | [optional]
**qr_encode_mode** | [**\Aspose\BarCode\Model\QREncodeMode**](QREncodeMode.md) | QR barcode encode mode. | [optional]
**qr_error_level** | [**\Aspose\BarCode\Model\QRErrorLevel**](QRErrorLevel.md) | QR barcode error correction level. | [optional]
**qr_version** | [**\Aspose\BarCode\Model\QRVersion**](QRVersion.md) | QR barcode version. Automatically selects the smallest version that fits the data. | [optional]
**qr_eci_encoding** | [**\Aspose\BarCode\Model\ECIEncodings**](ECIEncodings.md) | ECI encoding for QR barcode data. | [optional]
**qr_aspect_ratio** | **float** | QR barcode aspect ratio. Values: 0 to 1. | [optional]
**micro_qr_version** | [**\Aspose\BarCode\Model\MicroQRVersion**](MicroQRVersion.md) | | [optional]
**rect_micro_qr_version** | [**\Aspose\BarCode\Model\RectMicroQRVersion**](RectMicroQRVersion.md) | | [optional]
**micro_qr_version** | [**\Aspose\BarCode\Model\MicroQRVersion**](MicroQRVersion.md) | MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional]
**rect_micro_qr_version** | [**\Aspose\BarCode\Model\RectMicroQRVersion**](RectMicroQRVersion.md) | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional]

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

Expand Down
4 changes: 2 additions & 2 deletions docs/Model/RecognizeBase64Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Name | Type | Description | Notes
---- | ---- | ----------- | -----
**barcode_types** | [**\Aspose\BarCode\Model\DecodeBarcodeType[]**](DecodeBarcodeType.md) | Array of barcode decode types to find. |
**file_base64** | **string** | Barcode image bytes encoded as base-64. |
**recognition_mode** | [**\Aspose\BarCode\Model\RecognitionMode**](RecognitionMode.md) | | [optional]
**recognition_image_kind** | [**\Aspose\BarCode\Model\RecognitionImageKind**](RecognitionImageKind.md) | | [optional]
**recognition_mode** | [**\Aspose\BarCode\Model\RecognitionMode**](RecognitionMode.md) | Barcode recognition mode. | [optional]
**recognition_image_kind** | [**\Aspose\BarCode\Model\RecognitionImageKind**](RecognitionImageKind.md) | Image kind for recognition. | [optional]

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

Expand Down
16 changes: 9 additions & 7 deletions index.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use Aspose\BarCode\Configuration;
use Aspose\BarCode\GenerateApi;
use Aspose\BarCode\Requests\GenerateRequestWrapper;
use Aspose\BarCode\Model\{EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QREncodeMode, QRErrorLevel, QRVersion};
use Aspose\BarCode\Model\{BarcodeImageParams, EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat, QrParams, QREncodeMode, QRErrorLevel, QRVersion};

$config = new Configuration();
$config->setClientId('ClientId from https://dashboard.aspose.cloud/applications');
Expand All @@ -17,12 +17,14 @@
}

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

$api = new GenerateApi(null, $config);
$response = $api->generate($request);
Expand Down
7 changes: 7 additions & 0 deletions scripts/add-screaming-snake-enum-aliases.bash
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash
set -euo pipefail

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
MODEL_DIR="$( cd "${SCRIPT_DIR}/../src/Aspose/BarCode/Model" &> /dev/null && pwd )"

find "${MODEL_DIR}" -name "*.php" -exec python "${SCRIPT_DIR}/add-screaming-snake-enum-aliases.py" "{}" \;
Loading