phpSmug

phpSmug is a PHP wrapper class for the SmugMug API. The intention of this class is to allow PHP application developers to quickly and easily interact with the SmugMug API in their applications, without having to worry about the finer details of the API.

Not already a SmugMug user? Here, have a $5 discount off your first year on me by registering using this code:

2ZxFXMC19qOxU

Using phpSmug

Everything you need to know about using phpSmug can be found in the documentation which is built from the files in the docs/ directory in all downloads.

Contributing

If you would like to contribute to the development of phpSmug by offering enhancements or bug fixes, please feel free. I’m a big fan of GitHub’s “Fork & Pull” development methodology so…

  1. Fork the phpSmug repository on GitHub.
  2. If you’re submitting a fix or improvement to the phpSmug code or submitting a new example, create a new branch from the master branch, for example: your-fork/some-cool-feature or your-fork/fixing-something-broken branch.
  3. If you’re submitting a fix or improvement to the phpSmug website or documentation, create a new branch from the gh-pages branch.
  4. If you’re submitting code changes, as opposed to documentation, write tests that fail without your changes and pass with them.
  5. Ensure all tests pass locally by running: vendor/bin/phpunit within your local clone of the repository.
  6. Submit a pull request.

All pull requests will be reviewed and will be merged once all tests have passed.

Coding Standards

To try and keep things looking :sparkles:, please ensure your changes comply with the following coding standards:

All contributions are automatically checked against these standards using php-cs-fixer.

Reporting Issues

If you encounter a problem with phpSmug, please feel free to raise an issue. Please state which version of phpSmug you are using and ideally provide a small code snippet or link to a gist that can be used to reproduce the issue.

Getting Help

The best way to get help with implementing phpSmug into your projects is to open an issue. This allows you to easily search for other issues where others may have asked to the same questions or hit the same problems and if they haven’t, your issue will add to the resources available to others at a later date.

If you need a quick bit of help or just want to say “Hi and thanks”, please use Twitter with the #phpSmug hashtag or tweet me directly @lildude.

Donations

The development of phpSmug takes place in my free time. If you find phpSmug useful and found it has saved you a lot of time, I’d really appreciate it if you bought me a beer or two. Everyone knows code flows better lubricated by beer.

License

This is the boring part, so I’ve put it right at the end, phpSmug is released under the MIT license.

By contributing code you agree to license your contribution under the MIT license.

By contributing documentation, examples, or any other non-code assets you agree to license your contribution under the CC BY 3.0 license. Attribution shall be given according to the current bylaws of this group.

The images in the footer are the possession of SmugMug and their friends and are taken from one of their demo galleries.