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.

Sign up for GitHub

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

Document the Bugsnag facade #408

Merged
merged 6 commits into from
Sep 9, 2020
Merged

Document the Bugsnag facade #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3204dc8
documenting the bugsnag facade adding support to code-completion
Nov 16, 2019
beb254a
adding method setAppVersion
Nov 16, 2019
5d45fd5
adding new methods
Nov 16, 2019
a4d424f
adding setMetadata
Nov 16, 2019
2b2c6bd
Add documentation for all public methods
imjoehaines Sep 9, 2020
2f69c92
Add changelog entry for #373
imjoehaines Sep 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Changelog
[#405](https://github.com/bugsnag/bugsnag-laravel/pull/405)
[#407](https://github.com/bugsnag/bugsnag-laravel/pull/407)

* Add method documentation to the `Bugsnag` facade
[danieldevsquad](https://github.com/danieldevsquad)
[#373](https://github.com/bugsnag/bugsnag-laravel/pull/373)

## 2.19.0 (2020-05-11)

### Enhancements
Expand Down
54 changes: 54 additions & 0 deletions src/Facades/Bugsnag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,60 @@

use Illuminate\Support\Facades\Facade;

/**
* @method static void build(string|null $repository = null, string|null $revision = null, string|null $provider = null, string|null $builderName = null)
* @method static void clearBreadcrumbs()
* @method static void flush()
* @method static string getApiKey()
* @method static array getAppData()
* @method static string getBuildEndpoint()
* @method static \Bugsnag\Configuration getConfig()
* @method static array getDeviceData()
* @method static array getFilters()
* @method static array getMetaData()
* @method static array getNotifier()
* @method static string getNotifyEndpoint()
* @method static \Bugsnag\Pipeline getPipeline()
* @method static string getSessionEndpoint()
* @method static \Bugsnag\SessionTracker getSessionTracker()
* @method static string getStrippedFilePath(string $file)
* @method static bool isBatchSending()
* @method static string isInProject(string $file)
* @method static void leaveBreadcrumb(string $name, string|null $type = null, array $metaData = [])
* @method static void notify(\Bugsnag\Report $report, callable|null $callback = null)
* @method static void notifyError(string $name, string $message, callable|null $callback = null)
* @method static void notifyException(\Throwable $throwable, callable|null $callback = null)
* @method static void registerCallback(callable $callback)
* @method static void registerDefaultCallbacks()
* @method static void registerMiddleware(callable $middleware)
* @method static \Bugsnag\Client setAppType(string|null $type)
* @method static \Bugsnag\Client setAppVersion(string|null $appVersion)
* @method static \Bugsnag\Client setAutoCaptureSessions(bool $track)
* @method static \Bugsnag\Client setBatchSending(bool $batchSending)
* @method static \Bugsnag\Client setBuildEndpoint(string $endpoint)
* @method static \Bugsnag\Client setErrorReportingLevel(int|null $errorReportingLevel)
* @method static \Bugsnag\Client setFallbackType(string|null $type)
* @method static \Bugsnag\Client setFilters(array $filters)
* @method static \Bugsnag\Client setHostname(string|null $hostname)
* @method static \Bugsnag\Client setMetaData(array $metaData, bool $merge = true)
* @method static \Bugsnag\Client setNotifier(array $notifier)
* @method static \Bugsnag\Client setNotifyEndpoint(string $endpoint)
* @method static \Bugsnag\Client setNotifyReleaseStages(array|null $notifyReleaseStages = null)
* @method static \Bugsnag\Client setProjectRoot(string|null $projectRoot)
* @method static \Bugsnag\Client setProjectRootRegex(string|null $projectRootRegex)
* @method static \Bugsnag\Client setReleaseStage(string|null $releaseStage)
* @method static \Bugsnag\Client setSendCode(bool $sendCode)
* @method static \Bugsnag\Client setSessionEndpoint(string $endpoint)
* @method static \Bugsnag\Client setStripPath(string|null $stripPath)
* @method static \Bugsnag\Client setStripPathRegex(string|null $stripPathRegex)
* @method static bool shouldCaptureSessions()
* @method static bool shouldIgnoreErrorCode(int $code)
* @method static bool shouldNotify()
* @method static bool shouldSendCode()
* @method static void startSession()
*
* @see \Bugsnag\Client
*/
class Bugsnag extends Facade
{
protected static function getFacadeAccessor()
Expand Down