1. Go to this page and download the library: Download spiriitlabs/commit-history library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
spiriitlabs / commit-history example snippets
use Spiriit\CommitHistory\Contract\HttpClientInterface;
use Spiriit\CommitHistory\Provider\Github\GithubProvider;
use Spiriit\CommitHistory\Provider\Github\CommitParser;
use Spiriit\CommitHistory\Service\FeedFetcher;
// Implement the HttpClientInterface (see Contracts section below)
$httpClient = new MyHttpClient();
// Create a GitHub provider
$provider = new GithubProvider(
httpClient: $httpClient,
parser: new CommitParser(),
baseUrl: 'https://api.github.com',
owner: 'symfony',
repo: 'symfony',
token: 'ghp_xxxx', // optional,
use Spiriit\CommitHistory\Provider\Gitlab\GitlabProvider;
use Spiriit\CommitHistory\Provider\Gitlab\CommitParser;
$provider = new GitlabProvider(
httpClient: $httpClient,
parser: new CommitParser(),
baseUrl: 'https://gitlab.com', // or your self-hosted instance
projectId: '12345678',
token: 'glpat-xxxx', // optional
ref: 'main', // optional
);
use Spiriit\CommitHistory\Service\DependencyDetectionService;
$dependencyService = new DependencyDetectionService(
provider: $provider,
dependencyFiles: ['composer.json', 'composer.lock', 'package.json', 'package-lock.json'],
trackDependencyChanges: true,
);
$feedFetcher = new FeedFetcher(
provider: $provider,
dependencyDetectionService: $dependencyService,
);
$commits = $feedFetcher->fetch(2024);
foreach ($commits as $commit) {
if ($commit->hasDependenciesChanges) {
echo $commit->title . " (has dependency changes)\n";
}
}
// Fetch commits for a specific year (defaults to current year)
$commits = $feedFetcher->fetch(2024);
// Get available years for filtering
$years = $feedFetcher->getAvailableYears(); // [2024, 2023, 2022, ...]
use Spiriit\CommitHistory\Contract\HttpClientInterface;
use GuzzleHttp\Client;
class GuzzleHttpClient implements HttpClientInterface
{
private Client $client;
public function __construct()
{
$this->client = new Client();
}
public function request(string $method, string $url, array $headers = []): array
{
$response = $this->client->request($method, $url, ['headers' => $headers]);
return [
'status' => $response->getStatusCode(),
'headers' => $response->getHeaders(),
'body' => (string) $response->getBody(),
];
}
}
use Spiriit\CommitHistory\Provider\ProviderInterface;
use Spiriit\CommitHistory\Provider\CommitParserInterface;
use Spiriit\CommitHistory\DTO\Commit;
class BitbucketCommitParser implements CommitParserInterface
{
public function parse(array $data): Commit
{
// Parse Bitbucket API response into Commit DTO
}
}
class BitbucketProvider implements ProviderInterface
{
public function __construct(
private readonly HttpClientInterface $httpClient,
private readonly CommitParserInterface $parser,
// ... other params
) {}
public function getCommits(?\DateTimeImmutable $since = null, ?\DateTimeImmutable $until = null): array
{
// Fetch and parse commits from Bitbucket API
}
public function getCommitFileNames(string $commitId): array
{
// Return list of changed files for dependency detection
}
public function getCommitDiff(string $commitId): array
{
// Return map of filename => diff content
}
}
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.