Download the PHP package garethmidwood/codebasehq-php without Composer

On this page you can find all versions of the php package garethmidwood/codebasehq-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of garethmidwood/codebasehq-php

Informations about the package codebasehq-php

codebasehq-php

A PHP library for the CodebaseHQ API

Note

This library creates objects for users, projects, tickets etc. When you make a query to retrieve tickets (this is just an example, it can apply to other classes too) it will attempt to look up the users and link the ticket assignee/reporter with the user. If you haven't already retrieved users then your ticket will have no assignee or reporter assigned to it. Because of this, the best steps to take are:

Instructions for each of these steps can be found below.

Usage

Connecting to the API

In order to connect to and query the codebase API you need to create a CodebaseHQAccount object

Retrieving All Users

Users are pulled at the account level

This returns a User\Collection - searching should be done on the collection, the class has a few helper methods for this

Retrieving Projects

Projects can be pulled as a whole for the account, or individually by permalink.

Retrieving All Projects

Projects are also pulled at the account level

This returns a Project\Collection - searching should be done on the collection, the class has a few helper methods for this

Retrieving Individual Projects

You can pull an individual project by the permalink (note the method name is singular)

This returns a Project\Project - not a collection

Populating Project Details

Projects can be populated with all of their categories, priorities, statuses and types.

Retrieving Tickets for a Project

Tickets can only be retrieved if you have a Project\Project object.

The tickets method returns a boolean indicating whether there are further results (as the results are paginated). The tickets themselves are added to a Ticket\Collection in the project. As always, searching should be done on the collection, the class has a few helper methods for this

Pagination

Tickets are paginated, with 20 per page. You can write a simple loop to pull all tickets for the project

Retrieving Time Sessions for a Project

Time Sessions can only be retrieved if you have a Project\Project object. You must also pass through a period to retrieve the times for, this can be a day/week/month or all - classes exist for each one.

Time sessions will be associated with the project, the ticket and the user if you have populated those collections.

All versions of codebasehq-php with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package garethmidwood/codebasehq-php contains the following files

Loading the files please wait ....