Skip to content

Commit 5eecfd1

Browse files
committed
Docs on client interfaces
1 parent ded181b commit 5eecfd1

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

src/AsyncClientInterface.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,20 @@
1111

1212
interface AsyncClientInterface
1313
{
14+
/**
15+
* Take a string create by the extract method and hydrate it back to a resource.
16+
*
17+
* @param string $resource
18+
* @return CancellablePromiseInterface
19+
*/
1420
public function hydrate(string $resource): CancellablePromiseInterface;
1521

22+
/**
23+
* Extract a resource into a string for storage.
24+
*
25+
* @param ResourceInterface $resource
26+
* @return CancellablePromiseInterface
27+
*/
1628
public function extract(ResourceInterface $resource): CancellablePromiseInterface;
1729

1830
/**

src/ClientInterface.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,20 @@
1010

1111
interface ClientInterface
1212
{
13+
/**
14+
* Take a string create by the extract method and hydrate it back to a resource.
15+
*
16+
* @param string $resource
17+
* @return ResourceInterface
18+
*/
1319
public function hydrate(string $resource): ResourceInterface;
1420

21+
/**
22+
* Extract a resource into a string for storage.
23+
*
24+
* @param ResourceInterface $resource
25+
* @return string
26+
*/
1527
public function extract(ResourceInterface $resource): string;
1628

1729
/**

0 commit comments

Comments
 (0)