Skip to content

Commit 7479b11

Browse files
authored
Release 20.5 (#1)
* Switch to API v3.0 * Updated SDK
1 parent bf51552 commit 7479b11

File tree

175 files changed

+27186
-5239
lines changed

Some content is hidden

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

175 files changed

+27186
-5239
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
/*.lock
22
/vendor
33
/nbproject/private
4+
Configuration*.json
5+
!Configuration.example.json

README.md

Lines changed: 126 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
1-
# Aspose.BarCode Cloud SDK for PHP
2-
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.
1+
# Aspose.BarCode Cloud SDK for PHP
2+
3+
- API version: 3.0
4+
- Package version: 20.5
35

4-
This repository contains Aspose.BarCode Cloud SDK for PHP source code.
6+
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.
57

8+
This repository contains Aspose.BarCode Cloud SDK for PHP source code.
69

710
To use these SDKs, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
811

9-
## How to use the SDK?
12+
## How to use the SDK
13+
1014
You can either directly use it in your project via source code or get [Packagist distribution](https://packagist.org/packages/aspose/barcode-cloud-php) (recommended).
1115

1216
## Installation
1317

14-
## Via Composer:
18+
### Via Composer
19+
1520
*barcode-cloud-php* is available on Packagist as the
1621
[`barcode-cloud-php`](https://packagist.org/packages/aspose/barcode-cloud-php) package. Run the following command:
17-
```bash
22+
23+
```sh
1824
composer require aspose/barcode-cloud-php
1925
```
2026

21-
To use the SDK, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):
27+
To use the SDK, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
2228

2329
```php
2430
require __DIR__ . '/vendor/autoload.php';
@@ -27,37 +33,128 @@ require __DIR__ . '/vendor/autoload.php';
2733
### Sample usage
2834

2935
```php
30-
use Aspose\BarCode\Configuration;
31-
use Aspose\BarCode\BarCodeApi;
32-
use Aspose\BarCode\Requests\BarCodeGetBarCodeGenerateRequest;
33-
36+
use Aspose\BarCode\{Configuration, BarcodeApi, Model\EncodeBarcodeType, Requests\GetBarcodeGenerateRequest};
3437

3538
$config = new Configuration();
36-
$config->setAppKey("your_key");
37-
$config->setAppSid("your_sid");
39+
$config->setAppKey('App Key from https://dashboard.aspose.cloud/#/apps');
40+
$config->setAppSid('App SID from https://dashboard.aspose.cloud/#/apps');
41+
// Or use Configuration.json file
42+
//$config = Configuration::fromJson(file_get_contents('tests/Configuration.json'));
3843

39-
$request = new BarCodeGetBarCodeGenerateRequest();
40-
$request->type = "QR";
41-
$request->text = "PHP SDK Test";
42-
$request->format = "png";
44+
$request = new GetBarcodeGenerateRequest(EncodeBarcodeType::QR, 'PHP SDK Test');
45+
$request->format = 'png';
4346

44-
$api = new BarCodeApi(null, $config);
45-
$response = $api->BarCodeGetBarCodeGenerate($request);
47+
$api = new BarcodeApi(null, $config);
48+
$response = $api->GetBarCodeGenerate($request);
4649

4750
$type = 'image/png';
4851
$size = $response->getSize();
49-
header('Content-Type:'.$type);
50-
header('Content-Length: ' . $size);
52+
header("Content-Type: $type");
53+
header("Content-Length: $size");
5154
echo $response->fread($size);
5255
```
5356

54-
# Licensing
57+
## Licensing
58+
5559
All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
5660

57-
# Resources
58-
+ [**Website**](https://www.aspose.cloud)
59-
+ [**Product Home**](https://products.aspose.cloud/barcode/cloud)
60-
+ [**Documentation**](https://docs.aspose.cloud/display/barcodecloud/Home)
61-
+ [**Free Support Forum**](https://forum.aspose.cloud/c/barcode)
62-
+ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
63-
+ [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose-barcode-product-family/)
61+
## Resources
62+
63+
- [**Website**](https://www.aspose.cloud)
64+
- [**Product Home**](https://products.aspose.cloud/barcode/cloud)
65+
- [**Documentation**](https://docs.aspose.cloud/display/barcodecloud/Home)
66+
- [**Free Support Forum**](https://forum.aspose.cloud/c/barcode)
67+
- [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
68+
- [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose-barcode-product-family/)
69+
70+
## Documentation for API Endpoints
71+
72+
All URIs are relative to *<https://api.aspose.cloud/v3.0>*
73+
74+
Class | Method | HTTP request | Description
75+
------------ | ------------- | ------------- | -------------
76+
*BarcodeApi* | [**getBarcodeGenerate**](docs/Api/BarcodeApi.md#getbarcodegenerate) | **GET** /barcode/generate | Generate barcode.
77+
*BarcodeApi* | [**getBarcodeRecognize**](docs/Api/BarcodeApi.md#getbarcoderecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
78+
*BarcodeApi* | [**postBarcodeRecognizeFromUrlOrContent**](docs/Api/BarcodeApi.md#postbarcoderecognizefromurlorcontent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
79+
*BarcodeApi* | [**postGenerateMultiple**](docs/Api/BarcodeApi.md#postgeneratemultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
80+
*BarcodeApi* | [**putBarcodeGenerateFile**](docs/Api/BarcodeApi.md#putbarcodegeneratefile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
81+
*BarcodeApi* | [**putBarcodeRecognizeFromBody**](docs/Api/BarcodeApi.md#putbarcoderecognizefrombody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
82+
*BarcodeApi* | [**putGenerateMultiple**](docs/Api/BarcodeApi.md#putgeneratemultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
83+
*FileApi* | [**copyFile**](docs/Api/FileApi.md#copyfile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
84+
*FileApi* | [**deleteFile**](docs/Api/FileApi.md#deletefile) | **DELETE** /barcode/storage/file/{path} | Delete file
85+
*FileApi* | [**downloadFile**](docs/Api/FileApi.md#downloadfile) | **GET** /barcode/storage/file/{path} | Download file
86+
*FileApi* | [**moveFile**](docs/Api/FileApi.md#movefile) | **PUT** /barcode/storage/file/move/{srcPath} | Move file
87+
*FileApi* | [**uploadFile**](docs/Api/FileApi.md#uploadfile) | **PUT** /barcode/storage/file/{path} | Upload file
88+
*FolderApi* | [**copyFolder**](docs/Api/FolderApi.md#copyfolder) | **PUT** /barcode/storage/folder/copy/{srcPath} | Copy folder
89+
*FolderApi* | [**createFolder**](docs/Api/FolderApi.md#createfolder) | **PUT** /barcode/storage/folder/{path} | Create the folder
90+
*FolderApi* | [**deleteFolder**](docs/Api/FolderApi.md#deletefolder) | **DELETE** /barcode/storage/folder/{path} | Delete folder
91+
*FolderApi* | [**getFilesList**](docs/Api/FolderApi.md#getfileslist) | **GET** /barcode/storage/folder/{path} | Get all files and folders within a folder
92+
*FolderApi* | [**moveFolder**](docs/Api/FolderApi.md#movefolder) | **PUT** /barcode/storage/folder/move/{srcPath} | Move folder
93+
*StorageApi* | [**getDiscUsage**](docs/Api/StorageApi.md#getdiscusage) | **GET** /barcode/storage/disc | Get disc usage
94+
*StorageApi* | [**getFileVersions**](docs/Api/StorageApi.md#getfileversions) | **GET** /barcode/storage/version/{path} | Get file versions
95+
*StorageApi* | [**objectExists**](docs/Api/StorageApi.md#objectexists) | **GET** /barcode/storage/exist/{path} | Check if file or folder exists
96+
*StorageApi* | [**storageExists**](docs/Api/StorageApi.md#storageexists) | **GET** /barcode/storage/{storageName}/exist | Check if storage exists
97+
98+
## Documentation For Models
99+
100+
- [AustralianPostParams](docs/Model/AustralianPostParams.md)
101+
- [AutoSizeMode](docs/Model/AutoSizeMode.md)
102+
- [AvailableGraphicsUnit](docs/Model/AvailableGraphicsUnit.md)
103+
- [AztecParams](docs/Model/AztecParams.md)
104+
- [AztecSymbolMode](docs/Model/AztecSymbolMode.md)
105+
- [BarCodeErrorResponse](docs/Model/BarCodeErrorResponse.md)
106+
- [BarcodeResponse](docs/Model/BarcodeResponse.md)
107+
- [BarcodeResponseList](docs/Model/BarcodeResponseList.md)
108+
- [BorderDashStyle](docs/Model/BorderDashStyle.md)
109+
- [CaptionParams](docs/Model/CaptionParams.md)
110+
- [ChecksumValidation](docs/Model/ChecksumValidation.md)
111+
- [CodabarChecksumMode](docs/Model/CodabarChecksumMode.md)
112+
- [CodabarParams](docs/Model/CodabarParams.md)
113+
- [CodabarSymbol](docs/Model/CodabarSymbol.md)
114+
- [CodablockParams](docs/Model/CodablockParams.md)
115+
- [Code16KParams](docs/Model/Code16KParams.md)
116+
- [CodeLocation](docs/Model/CodeLocation.md)
117+
- [CouponParams](docs/Model/CouponParams.md)
118+
- [CustomerInformationInterpretingType](docs/Model/CustomerInformationInterpretingType.md)
119+
- [DataBarParams](docs/Model/DataBarParams.md)
120+
- [DataMatrixEccType](docs/Model/DataMatrixEccType.md)
121+
- [DataMatrixEncodeMode](docs/Model/DataMatrixEncodeMode.md)
122+
- [DataMatrixParams](docs/Model/DataMatrixParams.md)
123+
- [DecodeBarcodeType](docs/Model/DecodeBarcodeType.md)
124+
- [DiscUsage](docs/Model/DiscUsage.md)
125+
- [DotCodeParams](docs/Model/DotCodeParams.md)
126+
- [ECIEncodings](docs/Model/ECIEncodings.md)
127+
- [EnableChecksum](docs/Model/EnableChecksum.md)
128+
- [EncodeBarcodeType](docs/Model/EncodeBarcodeType.md)
129+
- [Error](docs/Model/Error.md)
130+
- [ErrorDetails](docs/Model/ErrorDetails.md)
131+
- [FileVersions](docs/Model/FileVersions.md)
132+
- [FilesList](docs/Model/FilesList.md)
133+
- [FilesUploadResult](docs/Model/FilesUploadResult.md)
134+
- [FontMode](docs/Model/FontMode.md)
135+
- [FontParams](docs/Model/FontParams.md)
136+
- [FontStyle](docs/Model/FontStyle.md)
137+
- [GeneratorParams](docs/Model/GeneratorParams.md)
138+
- [GeneratorParamsList](docs/Model/GeneratorParamsList.md)
139+
- [ITF14BorderType](docs/Model/ITF14BorderType.md)
140+
- [ITFParams](docs/Model/ITFParams.md)
141+
- [MaxiCodeParams](docs/Model/MaxiCodeParams.md)
142+
- [ObjectExist](docs/Model/ObjectExist.md)
143+
- [Padding](docs/Model/Padding.md)
144+
- [Pdf417CompactionMode](docs/Model/Pdf417CompactionMode.md)
145+
- [Pdf417ErrorLevel](docs/Model/Pdf417ErrorLevel.md)
146+
- [Pdf417Params](docs/Model/Pdf417Params.md)
147+
- [PostalParams](docs/Model/PostalParams.md)
148+
- [PresetType](docs/Model/PresetType.md)
149+
- [QREncodeMode](docs/Model/QREncodeMode.md)
150+
- [QREncodeType](docs/Model/QREncodeType.md)
151+
- [QRErrorLevel](docs/Model/QRErrorLevel.md)
152+
- [QRVersion](docs/Model/QRVersion.md)
153+
- [QrParams](docs/Model/QrParams.md)
154+
- [ReaderParams](docs/Model/ReaderParams.md)
155+
- [RegionPoint](docs/Model/RegionPoint.md)
156+
- [ResultImageInfo](docs/Model/ResultImageInfo.md)
157+
- [StorageExist](docs/Model/StorageExist.md)
158+
- [StorageFile](docs/Model/StorageFile.md)
159+
- [TextAlignment](docs/Model/TextAlignment.md)
160+
- [FileVersion](docs/Model/FileVersion.md)

composer.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,18 @@
1212
}
1313
],
1414
"require": {
15-
"guzzlehttp/guzzle": "^6.2"
15+
"guzzlehttp/guzzle": "^6.2",
16+
"ext-json": "*"
17+
},
18+
"require-dev": {
19+
"phpunit/phpunit": ">=7.5.20"
1620
},
1721
"autoload": {
1822
"psr-4": {
19-
"Aspose\\": "src/"
23+
"Aspose\\": "src/Aspose/"
2024
}
25+
},
26+
"scripts": {
27+
"test": "phpunit --testdox tests"
2128
}
2229
}

0 commit comments

Comments
 (0)