Skip to content

Commit 6effbec

Browse files
docs: update markdown API reference [skip ci]
1 parent af05155 commit 6effbec

File tree

2 files changed

+1
-108
lines changed

2 files changed

+1
-108
lines changed

docs/Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
This is an automatically generated documentation for **Documentation**.
2+
This is an automatically generated documentation for **PHP SDK for Lingo.dev**.
33

44
## Namespaces
55

docs/classes/LingoDotDev/Sdk/LingoDotDevEngine.md

Lines changed: 0 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,6 @@ progress reporting, and surfacing validation or transport errors.
1313

1414
* https://lingo.dev
1515

16-
## Properties
17-
18-
### config
19-
20-
Configuration options for the Engine.
21-
22-
```php
23-
protected array<string,mixed> $config
24-
```
25-
26-
***
27-
28-
### _httpClient
29-
30-
HTTP client for API requests.
31-
32-
```php
33-
private \GuzzleHttp\Client $_httpClient
34-
```
35-
36-
***
37-
3816
## Methods
3917

4018
### __construct
@@ -62,91 +40,6 @@ When API key is missing or values fail validation
6240

6341
***
6442

65-
### _localizeChunk
66-
67-
Localize a single chunk of content.
68-
69-
```php
70-
private _localizeChunk(string|null $sourceLocale, string $targetLocale, array<string,mixed> $payload, string $workflowId, bool $fast): array<string,mixed>
71-
```
72-
73-
**Parameters:**
74-
75-
| Parameter | Type | Description |
76-
|-----------------|-------------------------|--------------------------------------------------------------------------------|
77-
| `$sourceLocale` | **string\|null** | Language code of the original text (e.g., 'en', 'es'), null for auto-detection |
78-
| `$targetLocale` | **string** | Language code to translate into (e.g., 'fr', 'de') |
79-
| `$payload` | **array<string,mixed>** | Content chunk with optional reference data for context |
80-
| `$workflowId` | **string** | Unique identifier for tracking related translation requests |
81-
| `$fast` | **bool** | Enable faster translation at potential quality tradeoff |
82-
83-
**Return Value:**
84-
85-
Translated chunk maintaining original structure
86-
87-
**Throws:**
88-
89-
When reference is not an array
90-
- [`InvalidArgumentException`](../../InvalidArgumentException)
91-
When API request fails
92-
- [`RuntimeException`](../../RuntimeException)
93-
94-
***
95-
96-
### _extractPayloadChunks
97-
98-
Extract payload chunks based on the ideal chunk size.
99-
100-
```php
101-
private _extractPayloadChunks(array<string,mixed> $payload): array<int,array<string,mixed>>
102-
```
103-
104-
**Parameters:**
105-
106-
| Parameter | Type | Description |
107-
|------------|-------------------------|---------------------------|
108-
| `$payload` | **array<string,mixed>** | The payload to be chunked |
109-
110-
**Return Value:**
111-
112-
Array of payload chunks
113-
114-
***
115-
116-
### _countWordsInRecord
117-
118-
Count words in a record or array.
119-
120-
```php
121-
private _countWordsInRecord(mixed $payload): int
122-
```
123-
124-
**Parameters:**
125-
126-
| Parameter | Type | Description |
127-
|------------|-----------|-------------------------------|
128-
| `$payload` | **mixed** | The payload to count words in |
129-
130-
**Return Value:**
131-
132-
Total number of words
133-
134-
***
135-
136-
### _createId
137-
138-
Generate a unique ID.
139-
140-
```php
141-
private _createId(): string
142-
```
143-
144-
**Return Value:**
145-
146-
Unique ID
147-
148-
***
149-
15043
### localizeObject
15144

15245
Localize every string in a nested array while keeping its shape intact.

0 commit comments

Comments
 (0)