Download the PHP package stdtabs/phptabs without Composer
On this page you can find all versions of the php package stdtabs/phptabs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package phptabs
PhpTabs
PhpTabs is a PHP library for reading and writing scores and MIDI files. It provides direct methods to read a song name, get a list of instruments or whatever be your needs.
PhpTabs currently supports the following file formats:
- Guitar Pro 3 (.gp3)
- Guitar Pro 4 (.gp4)
- Guitar Pro 5 (.gp5)
- MIDI (.mid, .midi)
Any questions?
- Read the PhpTabs Manual
- Open an issue on github
- Contribute code
- Contribute documentation in the /docs
Table of contents
The documentation below contains only basic examples. If you want to see more examples and the complete API behind the library, read the PhpTabs Manual.
Before version 1.0.0, the old manual PhpTabs Manual
- Requirements
- Installation
- Composer
- Alternative
- Testing
- Basic Usage
- Methods
- Accessing metadata
- getName()
- getArtist()
- getAlbum()
- getAuthor()
- getCopyright()
- getWriter()
- getComments()
- getTranscriber()
- getDate()
- Accessing tracks
- countTracks()
- getTracks()
- getTrack()
- Accessing channels
- countChannels()
- getChannels()
- getChannel()
- Accessing instruments
- countInstruments()
- getInstruments()
- getInstrument()
- Accessing measure headers
- countMeasureHeaders()
- getMeasureHeaders()
- getMeasureHeader()
- Saving data
- save()
- export()
- convert()
Requirements
PhpTabs requires PHP 7.4+ and 8.0+.
Until PhpTabs 1.0.5, it was maintained for PHP versions 7.2 and 7.3.
Until PhpTabs 0.6.1, it was maintained for PHP versions 7.0 and 7.1.
Until PhpTabs 0.6.0, it was maintained for PHP versions 5.4, 5.5, 5.6 and HHVM.
Installation
Composer
Alternative
Download and extract an archive from https://github.com/stdtabs/phptabs/releases
Then add this PHP line before usage:
Testing
To run tests, you should install PHPUnit first.
Then run the test suite with:
Basic Usage
Methods
Accessing metadata
getName()
Type string
The name of the song.
Example
getArtist()
Type string
The interpreter of the song.
Example
getAlbum()
Type string
The name of the album.
Example
getAuthor()
Type string
The author of the song.
Example
getCopyright()
Type string
The copyright of the song.
Example
getWriter()
Type string
The songwriter.
Example
getComments()
Type string
The tablature comments. They are compounded of several lines separated by a line break ().
Example
getTranscriber()
Type string
Person who has transcribed tablature
Support
Guitar Pro >= 4
Example
getDate()
Type string
Date when tablature has been transcribed
Support
Guitar Pro >= 4
Example
Accessing tracks
countTracks()
Type integer
The number of tracks
Example
getTracks()
Type array
An array of Track objects
There is one track object for each instrument of the song.
Example
getTrack($index)
Type object
Parameter integer $index
The music sheet for one instrument.
Example
Accessing channels
countChannels()
Type integer
The number of channels
Example
getChannels()
Type array
An array of Channel objects
There is one channel object for each track of the song.
Example
getChannel($index)
Type object
Parameter integer $index
The instrument and sound parameters for one track.
Example
Accessing instruments
countInstruments()
Type integer
The number of instruments
Example
getInstruments()
Type array
A list of instrument arrays
Example
getInstrument($index)
Type array
Parameter integer $index
An instrument array
Example
Accessing measure headers
countMeasureHeaders()
Type integer
The number of measure headers
Example
getMeasureHeaders()
Type array
An array of MeasureHeader objects
Example
getMeasureHeader($index)
Type object
Parameter integer $index
Measure header contains global informations about the measure.
Example
Saving data
save($filename)
Type bool
Parameter string $filename
This method records data as binary to the disk or buffer. It implicitly converts filetype if the specified file extension is different from the original (see examples below).
Following parameters are allowed:
Parameter | Type | Description |
---|---|---|
filename.ext | bool | A file_put_contents() return |
Example
convert($type)
Type string
Parameter string $type
This method returns data as a binary string into a specified format.
Following formats are allowed:
Parameter | Type | Description |
---|---|---|
null | string | A binary string, original format |
gp3 | string | A binary string, GP3 formatted |
gp4 | string | A binary string, GP4 formatted |
gp5 | string | A binary string, GP5 formatted |
mid | string | A binary string, MIDI formatted |
midi | string | A binary string, MIDI formatted |
Example
A lot more examples on PhpTabs Manual.