Skip to content

Commit

Permalink
Update phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Feb 16, 2024
1 parent 0047dcc commit cfeaae2
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 36 deletions.
4 changes: 2 additions & 2 deletions docs/classes/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CommonGateway\ZGWToZDSBundle

* [Service\InstallationService](Service/InstallationService.md)
* [Service\ZGWToZDSService](Service/ZGWToZDSService.md)
* [Service\InstallationService](Service/InstallationService.md)
* [Service\ZGWToZDSService](Service/ZGWToZDSService.md)
64 changes: 49 additions & 15 deletions docs/classes/Service/InstallationService.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,63 @@
# CommonGateway\ZGWToZDSBundle\Service\InstallationService
# CommonGateway\ZGWToZDSBundle\Service\InstallationService


## Implements:

## Implements:
CommonGateway\CoreBundle\Installer\InstallerInterface



## Methods

| Name | Description |
|------|-------------|
|[\_\_construct](#installationservice__construct)|The constructor|
|[__construct](#installationservice__construct)|The constructor|
|[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle|
|[install](#installationserviceinstall)|Every installation service should implement an install function|
|[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function|
|[update](#installationserviceupdate)|Every installation service should implement an update function|

### InstallationService::\_\_construct



### InstallationService::__construct

**Description**

```php
public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger)
```

The constructor
The constructor



**Parameters**

* `(\EntityManagerInterface) $entityManager`
: The entity manager.
: The entity manager.
* `(\LoggerInterface) $installationLogger`
: The installation logger.
: The installation logger.

**Return Values**

`void`


<hr />

### InstallationService::checkDataConsistency

### InstallationService::checkDataConsistency

**Description**

```php
public checkDataConsistency (void)
```

The actual code run on update and installation of this bundle
The actual code run on update and installation of this bundle



**Parameters**

Expand All @@ -55,17 +67,23 @@ The actual code run on update and installation of this bundle

`void`




<hr />

### InstallationService::install

### InstallationService::install

**Description**

```php
public install (void)
```

Every installation service should implement an install function
Every installation service should implement an install function



**Parameters**

Expand All @@ -75,17 +93,23 @@ Every installation service should implement an install function

`void`




<hr />

### InstallationService::uninstall

### InstallationService::uninstall

**Description**

```php
public uninstall (void)
```

Every installation service should implement an uninstall function
Every installation service should implement an uninstall function



**Parameters**

Expand All @@ -95,17 +119,23 @@ Every installation service should implement an uninstall function

`void`




<hr />

### InstallationService::update

### InstallationService::update

**Description**

```php
public update (void)
```

Every installation service should implement an update function
Every installation service should implement an update function



**Parameters**

Expand All @@ -115,4 +145,8 @@ Every installation service should implement an update function

`void`




<hr />

99 changes: 80 additions & 19 deletions docs/classes/Service/ZGWToZDSService.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,37 @@
# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService
# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService







## Methods

| Name | Description |
|------|-------------|
|[\_\_construct](#zgwtozdsservice__construct)||
|[__construct](#zgwtozdsservice__construct)||
|[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.|
|[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier|
|[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.|
|[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier|
|[zgwToZdsXmlEncodeHandler](#zgwtozdsservicezgwtozdsxmlencodehandler)|Does an xmlEncode on the response data. (temporary solution)|

### ZGWToZDSService::\_\_construct



### ZGWToZDSService::__construct

**Description**

```php
__construct (void)
```





**Parameters**

`This function has no parameters.`
Expand All @@ -26,104 +40,151 @@

`void`


<hr />

### ZGWToZDSService::zgwToZdsHandler

### ZGWToZDSService::zgwToZdsHandler

**Description**

```php
public zgwToZdsHandler (array $data, array $configuration)
```

An example handler that is triggered by an action.
An example handler that is triggered by an action.



**Parameters**

* `(array) $data`
: The data array
: The data array
* `(array) $configuration`
: The configuration array
: The configuration array

**Return Values**

`array`

> A handler must ALWAYS return an array

<hr />

### ZGWToZDSService::zgwToZdsIdentificationHandler

### ZGWToZDSService::zgwToZdsIdentificationHandler

**Description**

```php
public zgwToZdsIdentificationHandler (array $data, array $configuration)
```

Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier
Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier



**Parameters**

* `(array) $data`
: The data from the response.
: The data from the response.
* `(array) $configuration`
: The configuration for this action.
: The configuration for this action.

**Return Values**

`array`

> The resulting data array.

<hr />

### ZGWToZDSService::zgwToZdsInformationObjectHandler

### ZGWToZDSService::zgwToZdsInformationObjectHandler

**Description**

```php
public zgwToZdsInformationObjectHandler (array $data, array $configuration)
```

Translate information objects to Lk01 messages and send them to a source.
Translate information objects to Lk01 messages and send them to a source.



**Parameters**

* `(array) $data`
: The data array
: The data array
* `(array) $configuration`
: The configuration array
: The configuration array

**Return Values**

`array`

> The updated data array

<hr />

### ZGWToZDSService::zgwToZdsObjectIdentificationHandler

### ZGWToZDSService::zgwToZdsObjectIdentificationHandler

**Description**

```php
public zgwToZdsObjectIdentificationHandler (array $data, array $configuration)
```

Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier
Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier



**Parameters**

* `(array) $data`
: The data from the response.
: The data from the response.
* `(array) $configuration`
: The configuration for this action.
: The configuration for this action.

**Return Values**

`array`

> The resulting data array.

<hr />


### ZGWToZDSService::zgwToZdsXmlEncodeHandler

**Description**

```php
public zgwToZdsXmlEncodeHandler (array $data, array $configuration)
```

Does an xmlEncode on the response data. (temporary solution)



**Parameters**

* `(array) $data`
: The data array.
* `(array) $configuration`
: The configuration array.

**Return Values**

`array`

> The updated data array.

<hr />

0 comments on commit cfeaae2

Please sign in to comment.