Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ArangoDBClient\GraphHandler\saveEdge PHPDoc Issue #257

Open
mstrofbass opened this issue Nov 17, 2018 · 0 comments
Open

ArangoDBClient\GraphHandler\saveEdge PHPDoc Issue #257

mstrofbass opened this issue Nov 17, 2018 · 0 comments

Comments

@mstrofbass
Copy link

I might be misunderstanding or missing something...so preemptively sorry.

The PHPdoc for ArangoDBClient\GraphHandler\saveEdge states that:

@param string $collection - if one uses a graph with more than one vertex collection one must provide the collection

I believe that "vertex" should be "edge", specifically because it initially confused me then I saw that the associated code is:

    if ($collection === null) {
        $edgeCollections      = $this->getEdgeCollections($graph);
        $edgeCollectionsCount = count($edgeCollections);
        if ($edgeCollectionsCount !== 1) {
            throw new ClientException('A collection must be provided.');
        }

        if ($edgeCollectionsCount === 1) {
            $collection = $edgeCollections[0];
        }
    }

Link to relevant docs:

* @param string $collection - if one uses a graph with more than one vertex collection one must provide the collection

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant