README

A StarCitizen API wrapper. Utilises the API from http://sc-api.com

Installation

You can install this framework with Composer just install Composer and then type

composer require stedop/starcitizen ~1.0

into the command line at your project root and you're good to

Usage

To get information

use StarCitizen\Accounts\Accounts;

$profile = Accounts::findProfile(<userName>);
$threads = Accounts::findThreads(<userName>);
$posts = Accounts::findPosts(<userName>);

use StarCitizen\Organisations\Organisations;

$org = Organisations::findOrg(<orgName>);
$members = Organisations::findMembers(<orgName>);

Loading other objects after getting some info

If you want to get a profiles' latest posts or threads

$profile = Accounts::findProfile(<userName>);

/*
    ...some code
*/

$posts = $profile->posts;
$threads = $profile->threads;

$members = $org->members;

This returns the posts or threads or you don't have to assign the posts or thread to a var, simply use

foreach ($profile->posts as $post) {
    // ....your code
}

Eager loading

If you wanted to load the objects when you find the profile

$profile = Accounts::findProfile(<userName>)->with('posts', 'threads');
$org = Organisations::findOrg(<orgName>)->with('members');

Using StarCitizens directly

You can use the StarCitizens object directly

use StarCitizens\StarCitizens
$sc = new StarCitizens();

$profile = $sc->accounts(<username>);
$threads = $sc->accounts(<username>, 'threads')

Also to get raw json output

$profile = $sc->accounts(<username>, '',true);

Please review the code for further information

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Credits

Thanks to Siegen on the RSI forums for building the API (I'm so glad I didn't have to)

License

This project is licensed under the terms of the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

stedop / starcitizens

Maintainers

Details