Added symlink functionality via X-Object-Manifest header management

[markchalloner]

Implementation of #561

[ycombinator]

Thanks for the PR, @markchalloner! We'll review it shortly and provide any feedback.

[ycombinator]

Could you please add a description for this parameter? We are starting to auto-generate API documentation so the description would be useful to readers.

[markchalloner]

Done.

[ycombinator]

I suspect I need to add a mock response somewhere? I'm not entirely sure what the correct way of doing this is. Any pointers?

You are correct about setting up a mock response before your unit test calls createSymlinkFrom/To. You can see some examples of setting up mock responses in here: https://github.com/rackspace/php-opencloud/blob/working/tests/OpenCloud/Tests/ObjectStore/Resource/ContainerTest.php. Search the file for $this->addMockSubscriber(.

[ycombinator]

Instead of returning null for an error case, lets throw an exception instead. This has the following benefits:

• it will keep error-handling consistent within this method. Just as you throw Exceptions\NoNameError when the object has no name, you can throw another exception if the object has content in it.
• by using an exception instead of returning null, we can provide more information to the caller about what went wrong.

Feel free to re-use an exception class from https://github.com/markchalloner/php-opencloud/tree/working/lib/OpenCloud/Common/Exceptions or add your own if you can't find one that's appropriate.

This same comment applies to the createSymlinkFrom method.

[ycombinator]

Hey @markchalloner, could you please remove the null from the @return type and description? Also, could you please add the necessary @throws documentation for the exceptions thrown by this method?

[ycombinator]

Hey @markchalloner, this is looking quite good. I have made a couple of minor suggestions about using exceptions instead of returning nulls, and I've provided a pointer to setting up mock responses. Once those changes are in, I'll be happy to merge this PR. Thanks!

[coveralls]

Coverage decreased (-0.16%) to 88.15% when pulling ceebd95 on markchalloner:working into 8105fa1 on rackspace:working.

[ycombinator]

Hey @markchalloner, could you please remove the null from the @return type and description? Also, could you please add the necessary @throws documentation for the exceptions thrown by this method?

[markchalloner]

Whoops missed that. Updated now. Cheers

[ycombinator]

@markchalloner Thanks for the unit test using MockSubscriber. You are right about the number of requests - it is quite a lot! Unfortunately, this is a bit of a known issue with this version of php-opencloud. I can't think of a way to work around it so I would keep your code as-is for now. We are currently in the early stages of planning a newer, much more efficient PHP SDK. In this new SDK, we'll be sure to provide the object symlinking capability as efficiently as possible.

I've made two minor comments re: docblocks. Once those are addressed, I'll merge this PR. Very nice work on this with the implementation, tests and documentation!

[ycombinator]

Once again, awesome job @markchalloner. Thank you for this contribution!