github.php

Aller à la documentation de ce fichier.

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  GitHub
 *
 * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

/**
 * Joomla Platform class for interacting with a GitHub server instance.
 *
 * @property-read  JGithubGists       $gists       GitHub API object for gists.
 * @property-read  JGithubIssues      $issues      GitHub API object for issues.
 * @property-read  JGithubPulls       $pulls       GitHub API object for pulls.
 * @property-read  JGithubRefs        $refs        GitHub API object for referencess.
 * @property-read  JGithubForks       $forks       GitHub API object for forks.
 * @property-read  JGithubCommits     $commits     GitHub API object for commits.
 * @property-read  JGithubMilestones  $milestones  GitHub API object for commits.
 * @property-read  JGithubStatuses    $statuses    GitHub API object for commits.
 * @property-read  JGithubAccount     $account     GitHub API object for account references.
 * @property-read  JGithubHooks       $hooks       GitHub API object for hooks.
 * @property-read  JGithubUsers       $users       GitHub API object for users.
 * @property-read  JGithubMeta        $meta        GitHub API object for meta.
 *
 * @package     Joomla.Platform
 * @subpackage  GitHub
 * @since       11.3
 */
class JGithub
{
        /**
         * @var    JRegistry  Options for the GitHub object.
         * @since  11.3
         */
        protected $options;

        /**
         * @var    JGithubHttp  The HTTP client object to use in sending HTTP requests.
         * @since  11.3
         */
        protected $client;

        /**
         * @var    JGithubGists  GitHub API object for gists.
         * @since  11.3
         */
        protected $gists;

        /**
         * @var    JGithubIssues  GitHub API object for issues.
         * @since  11.3
         */
        protected $issues;

        /**
         * @var    JGithubPulls  GitHub API object for pulls.
         * @since  11.3
         */
        protected $pulls;

        /**
         * @var    JGithubRefs  GitHub API object for referencess.
         * @since  11.3
         */
        protected $refs;

        /**
         * @var    JGithubForks  GitHub API object for forks.
         * @since  11.3
         */
        protected $forks;

        /**
         * @var    JGithubCommits  GitHub API object for commits.
         * @since  12.1
         */
        protected $commits;

        /**
         * @var    JGithubMilestones  GitHub API object for milestones.
         * @since  12.3
         */
        protected $milestones;

        /**
         * @var    JGithubStatuses  GitHub API object for statuses.
         * @since  12.3
         */
        protected $statuses;

        /**
         * @var    JGithubAccount  GitHub API object for account references.
         * @since  12.3
         */
        protected $account;

        /**
         * @var    JGithubHooks  GitHub API object for hooks.
         * @since  12.3
         */
        protected $hooks;

        /**
         * @var    JGithubUsers  GitHub API object for users.
         * @since  12.4
         */
        protected $users;

        /**
         * @var    JGithubMeta  GitHub API object for meta.
         * @since  13.1
         */
        protected $meta;

        /**
         * Constructor.
         *
         * @param   JRegistry    $options  GitHub options object.
         * @param   JGithubHttp  $client   The HTTP client object.
         *
         * @since   11.3
         */
        public function __construct(JRegistry $options = null, JGithubHttp $client = null)
        {
                $this->options = isset($options) ? $options : new JRegistry;
                $this->client  = isset($client) ? $client : new JGithubHttp($this->options);

                // Setup the default API url if not already set.
                $this->options->def('api.url', 'https://api.github.com');
        }

        /**
         * Magic method to lazily create API objects
         *
         * @param   string  $name  Name of property to retrieve
         *
         * @return  JGithubObject  GitHub API object (gists, issues, pulls, etc).
         *
         * @since   11.3
         * @throws  InvalidArgumentException
         */
        public function __get($name)
        {
                $class = 'JGithub' . ucfirst($name);

                if (class_exists($class))
                {
                        if (false == isset($this->$name))
                        {
                                $this->$name = new $class($this->options, $this->client);
                        }

                        return $this->$name;
                }

                throw new InvalidArgumentException(sprintf('Argument %s produced an invalid class name: %s', $name, $class));
        }

        /**
         * Get an option from the JGitHub instance.
         *
         * @param   string  $key  The name of the option to get.
         *
         * @return  mixed  The option value.
         *
         * @since   11.3
         */
        public function getOption($key)
        {
                return $this->options->get($key);
        }

        /**
         * Set an option for the JGitHub instance.
         *
         * @param   string  $key    The name of the option to set.
         * @param   mixed   $value  The option value to set.
         *
         * @return  JGitHub  This object for method chaining.
         *
         * @since   11.3
         */
        public function setOption($key, $value)
        {
                $this->options->set($key, $value);

                return $this;
        }
}