basic-setup.php

<?php
/**
 * ghissue-php Basic Setup Example
 *
 * This shows how to set up ghissue-php on your website.
 * Copy this to your project and modify as needed.
 */

// Option A: No Composer — use the built-in autoloader
require_once __DIR__ . '/../ghissue.php';

// Option B: With Composer (if you prefer)
// require_once __DIR__ . '/../vendor/autoload.php';

use GhIssue\GhIssue;

// =============================================================================
// 1. CONFIGURATION
// =============================================================================

// --- Option A: Config file (recommended) ---
// Copy ghissue-config.example.php to your project, fill in your values, then:
// $tracker = GhIssue::fromConfig(__DIR__ . '/ghissue-config.php');

// --- Option B: Inline configuration ---
// Create a GitHub Personal Access Token at:
// https://github.com/settings/tokens
// Required scopes: repo (for private repos) or public_repo (for public repos)
$tracker = new GhIssue(
    token:   getenv('GHISSUE_TOKEN') ?: 'ghp_your_token_here',
    owner:   'your-github-username',    // or your org name
    repo:    'your-issue-repo',         // the repo where issues will be created
    project: 'my-website',             // project identifier for multi-site setups
    options: [
        'storage_dir' => '/tmp/ghissue', // writable directory for rate limiting & cache
    ]
);

// =============================================================================
// 2. ONE-TIME SETUP — Run this once to create labels in your repo
// =============================================================================

// Uncomment and run once:
// $tracker->setupLabels();
// echo "Labels created!\n";
// exit;

// =============================================================================
// 3. REGISTER ERROR HANDLER — Auto-reports PHP errors to GitHub Issues
// =============================================================================

$tracker->registerErrorHandler([
    // URL where users can submit comments about errors
    'comment_endpoint' => '/ghissue/comment.php',
    // Show the built-in error page (set false if you have your own)
    'show_error_page' => true,
]);

// That's it! Now any unhandled exception or fatal error will:
// - Create a GitHub Issue (or add to existing one if duplicate)
// - Show a user-friendly error page with optional comment field

// =============================================================================
// 4. YOUR APPLICATION CODE
// =============================================================================

// Your normal application code goes here...
// Any uncaught exceptions will be automatically reported.

// Example: manually report something
// $tracker->report('Database connection slow', 'Response time exceeded 5s threshold', 'warning');