gitignore.php
1.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Gitignore class for the Joomla Platform.
*
* The .gitignore Templates API lists and fetches templates from the GitHub .gitignore repository.
*
* @documentation https://developer.github.com/v3/gitignore/
* @documentation https://github.com/github/gitignore
*
* @since 3.3.0
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageGitignore extends JGithubPackage
{
/**
* Listing available templates
*
* List all templates available to pass as an option when creating a repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList()
{
// Build the request path.
$path = '/gitignore/templates';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a single template
*
* @param string $name The name of the template
* @param boolean $raw Raw output
*
* @throws DomainException
* @since 3.3 (CMS)
*
* @return mixed|string
*/
public function get($name, $raw = false)
{
// Build the request path.
$path = '/gitignore/templates/' . $name;
$headers = array();
if ($raw)
{
$headers['Accept'] = 'application/vnd.github.raw+json';
}
$response = $this->client->get($this->fetchUrl($path), $headers);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message : 'Invalid response';
throw new DomainException($message, $response->code);
}
return ($raw) ? $response->body : json_decode($response->body);
}
}