2017 © Pedro Peláez
 

library octobercms-github-projects

image

pkleindienst/octobercms-github-projects

  • Sunday, May 21, 2017
  • by PascalKleindienst
  • Repository
  • 1 Watchers
  • 2 Stars
  • 1 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 4 Versions
  • 0 % Grown

The README.md

OctoberCMS GitHub Projects Plugin

Software License ![Build Status][ico-travis] HHVM ![StyleCI][ico-style] Quality Score ![Code Coverage][ico-code-coverage], (*1)

A plugin which utilizes to GitHub API to show informations about repositories., (*2)


Details

This plugin will provide a collection of components to display data about GitHub repositories based on the GitHub API v3., (*3)

As time passes more parts like Projects or Issues will be added to this collection of components., (*4)

Requirements

In order to work the PHP cURL extension must be installed and enabled., (*5)


Documentation

RepoList

List public repositories for the specified user., (*6)

Parameters

Name Type Description
user string The user whose repositories are displayed
type string The repository type. Can be one of all, owner, member. Default: owner
sort string The sorting field. Can be one of created, updated, pushed, full_name. Default: full_name
direction string The sort direction. Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

Item

Get a specific repository, (*7)

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/repos/#response-3, (*8)

Parameters

Name Type Description
user string The user whose repository is displayed
repo string The repository name

Gist

Get a specific repository, (*9)

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/gists/#get-a-single-gist, (*10)

Parameters

Name Type Description
id string ID of the gist

| sha | string | Get a specific revision of a gist |

Contributing

Please submit pull requests with translations or bugfixes on the plugin's GitHub page. Bug reports and feature requests via Issues are welcome!, (*11)

Security

If you discover any security related issues, please email security@pascalkleindienst.de instead of using the issue tracker., (*12)

Credits

License

The MIT License (MIT). Please see License File for more information., (*13)

The Versions

21/05 2017

dev-master

9999999-dev

  Sources   Download

MIT

The Requires

  • php >=5.5.9
  • ext-curl *

 

The Development Requires

21/05 2017

v1.2.0

1.2.0.0

  Sources   Download

MIT

The Requires

  • php >=5.5.9
  • ext-curl *

 

The Development Requires

22/04 2017

v1.0.1

1.0.1.0

  Sources   Download

MIT

The Requires

  • php >=5.5.9
  • ext-curl *

 

The Development Requires

04/11 2016

dev-analysis-zY27Vy

dev-analysis-zY27Vy

  Sources   Download

MIT

The Requires

  • php >=5.5.9

 

The Development Requires