Skip to content

Commit

Permalink
Update src from remark-lint
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed May 25, 2023
1 parent c16184b commit 9387c51
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 111 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)
68 changes: 17 additions & 51 deletions docs/classes/Service/InstallationService.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,51 @@
# CommonGateway\ZGWToZDSBundle\Service\InstallationService


# CommonGateway\ZGWToZDSBundle\Service\InstallationService

## Implements:
CommonGateway\CoreBundle\Installer\InstallerInterface


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.
* `(\LoggerInterface) $installationLogger`
: The installation logger.
* `(\EntityManagerInterface) $entityManager`
: The entity manager.
* `(\LoggerInterface) $installationLogger`
: 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 @@ -67,23 +55,17 @@ 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 @@ -93,23 +75,17 @@ 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 @@ -119,23 +95,17 @@ 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 @@ -145,8 +115,4 @@ Every installation service should implement an update function

`void`




<hr />

85 changes: 27 additions & 58 deletions docs/classes/Service/ZGWToZDSService.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,23 @@
# 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|




### ZGWToZDSService::__construct
### ZGWToZDSService::\_\_construct

**Description**

```php
__construct (void)
```





**Parameters**

`This function has no parameters.`
Expand All @@ -39,122 +26,104 @@

`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
* `(array) $configuration`
: The configuration array
* `(array) $data`
: The data array
* `(array) $configuration`
: 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.
* `(array) $configuration`
: The configuration for this action.
* `(array) $data`
: The data from the response.
* `(array) $configuration`
: 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
* `(array) $configuration`
: The configuration array
* `(array) $data`
: The data array
* `(array) $configuration`
: 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.
* `(array) $configuration`
: The configuration for this action.
* `(array) $data`
: The data from the response.
* `(array) $configuration`
: The configuration for this action.

**Return Values**

`array`

> The resulting data array.

<hr />

0 comments on commit 9387c51

Please sign in to comment.