{"id":17189893,"url":"https://github.com/kodjunkie/onesignal-php-sdk","last_synced_at":"2025-06-25T02:39:13.830Z","repository":{"id":37026185,"uuid":"392660185","full_name":"kodjunkie/onesignal-php-sdk","owner":"kodjunkie","description":"OneSignal SDK for PHP developers with fluent API and supports Laravel / Lumen out of the box.","archived":false,"fork":false,"pushed_at":"2025-02-24T09:02:04.000Z","size":167,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-18T00:46:56.311Z","etag":null,"topics":["api","apns","fcm","gcm","laravel","laravel-package","lumen","lumen-package","notifications","onesignal","onesignal-api","onesignal-php","onesignal-sdk","php","php-libray","push-notification","rest-client","restful-api","sdk","webpush"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/kodjunkie/onesignal-php-sdk","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kodjunkie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-08-04T11:20:03.000Z","updated_at":"2025-02-21T09:51:30.000Z","dependencies_parsed_at":"2025-04-13T19:37:18.975Z","dependency_job_id":"f02e14b2-30df-455d-87e1-c6ea8fb277e4","html_url":"https://github.com/kodjunkie/onesignal-php-sdk","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/kodjunkie/onesignal-php-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodjunkie%2Fonesignal-php-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodjunkie%2Fonesignal-php-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodjunkie%2Fonesignal-php-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodjunkie%2Fonesignal-php-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kodjunkie","download_url":"https://codeload.github.com/kodjunkie/onesignal-php-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodjunkie%2Fonesignal-php-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260951155,"owners_count":23087654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","apns","fcm","gcm","laravel","laravel-package","lumen","lumen-package","notifications","onesignal","onesignal-api","onesignal-php","onesignal-sdk","php","php-libray","push-notification","rest-client","restful-api","sdk","webpush"],"created_at":"2024-10-15T01:12:48.384Z","updated_at":"2025-06-25T02:39:13.806Z","avatar_url":"https://github.com/kodjunkie.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./onesignal.png\" alt=\"OneSignal\" height=\"100\" width=\"auto\" /\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"center\"\u003eOneSignal PHP SDK\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nOneSignal SDK for PHP developers with fluent API and supports Laravel / Lumen out of the box.\n\n[![Latest Stable Version](http://poser.pugx.org/kodjunkie/onesignal-php-sdk/v)](https://packagist.org/packages/kodjunkie/onesignal-php-sdk) [![PHP Version Require](http://poser.pugx.org/kodjunkie/onesignal-php-sdk/require/php)](https://packagist.org/packages/kodjunkie/onesignal-php-sdk) [![Total Downloads](http://poser.pugx.org/kodjunkie/onesignal-php-sdk/downloads)](https://packagist.org/packages/kodjunkie/onesignal-php-sdk) [![tests](https://github.com/kodjunkie/onesignal-php-sdk/actions/workflows/php.yml/badge.svg?branch=master)](https://github.com/kodjunkie/onesignal-php-sdk/actions/workflows/php.yml) \u003ca href=\"https://github.com/kodjunkie/onesignal-php-sdk/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-red.svg\" alt=\"license: MIT\" height=\"20\"\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n\n- How to use this package? [Click here](https://github.com/kodjunkie/onesignal-php-sdk/tree/master/docs)\n- For the official documentation [click here](https://documentation.onesignal.com/reference)\n\n## Why use this package?\n\n\u003e This is the only package out there that is a breeze to set up, and have a fluent / standardized API across endpoints.\n\n## Installation\n\n**NOTE:** For `laravel` users, this package registers itself automatically.\n\n```bash\ncomposer require kodjunkie/onesignal-php-sdk\n```\n\n### Usage in plain PHP\n\n```php\nuse Kodjunkie\\OnesignalPhpSdk\\OneSignal;\nuse Kodjunkie\\OnesignalPhpSdk\\Exceptions\\OneSignalException;\n\n$config = [\n    // Onesignal API Key\n    'api_key' =\u003e '',\n    // Onesignal Auth Key\n    'auth_key' =\u003e '',\n    // Onesignal App ID (optional)\n    // this is beneficial if you're working with a single OneSignal app\n    // so, you could pass \"null\" to methods / functions that requires it.\n    'app_id' =\u003e '',\n];\n\ntry {\n    // Initialize the SDK\n    $oneSignal = new OneSignal($config);\n    \n    // Using the API\n    // Get all apps\n    $response = $oneSignal-\u003eapp()-\u003egetAll();\n    \n    // Use json_decode() to get the response as an stdClass object\n    var_dump($response);\n} catch (OneSignalException $exception) {\n    var_dump($exception-\u003egetMessage());\n}\n```\n\n### Usage in Laravel / Lumen\n\nSet these values in your `.env` file\n\n```dotenv\nONESIGNAL_API_KEY=\nONESIGNAL_AUTH_KEY=\nONESIGNAL_APP_ID=\n```\n\n#### Register the service provider (lumen only)\n\nAdd this line to your `bootstrap/app.php` file\n\n```php\n$app-\u003eregister(Kodjunkie\\OnesignalPhpSdk\\OneSignalServiceProvider::class);\n\n// Register the facade (optional)\n// To use, must uncomment $app-\u003ewithFacades()\nif (!class_exists('OneSignal')) {\n    class_alias(Kodjunkie\\OnesignalPhpSdk\\Facade::class, 'OneSignal');\n}\n```\n\n#### Code samples\n\n```php\nuse Kodjunkie\\OnesignalPhpSdk\\Exceptions\\OneSignalException;\n\ntry {\n    // Initialize the SDK\n    // Resolve from the IoC container\n    $oneSignal = app()-\u003emake('onesignal');\n    \n    // Using the API\n    // Get all devices\n    $response = $oneSignal-\u003edevice()-\u003egetAll($appId, $limit, $offset);\n    \n    // Using the facade, the code above will look like this\n    // with \"app_id\" provided in the config\n    $response = OneSignal::device()-\u003egetAll(null, $limit, $offset);\n    \n    dd($response);\n} catch (OneSignalException $exception) {\n    dd($exception-\u003egetMessage());\n}\n```\n\n## Tests\n\n```bash\ncomposer test\n```\n\n## License\n\nThis project is opened under the [MIT 2.0 License](https://github.com/kodjunkie/onesignal-php-sdk/blob/master/LICENSE)\nwhich allows very broad use for both academic and commercial purposes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkodjunkie%2Fonesignal-php-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkodjunkie%2Fonesignal-php-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkodjunkie%2Fonesignal-php-sdk/lists"}