PhpTabs Documentation

Parse and write GuitarPro and MIDI files

Home Manual GitHub

API: Music / Song

Parent container
Accessing child nodes
Accessing properties
Updating children
Updating properties

Parent container

As the Song object is the root node of PhpTabs, it has no parent container.

You can access its methods by 2 ways:

$tab = new PhpTabs('mytabs.gp4');

// Directly
$tab->method();

// Getting the Song object
$tab->getSong()->method();

Accessing child nodes

countMeasureHeaders()

This method returns the number of measures contained by each track.

Type

integer

Example

$tab = new PhpTabs('mytabs.gp4');

// Count the number of measures
echo $tab->countMeasureHeaders();

// Will print a number between 0 and n-1

^ Table of contents

getMeasureHeader($index)

This method returns a MeasureHeader resource.

Parameters

integer $index

Type

\PhpTabs\Music\MeasureHeader

Example

$tab = new PhpTabs('mytabs.gp4');

// Get the fourth measure header
$header = $tab->getMeasureHeader(3);

if ($header !== null) {
	echo $header->getNumber();
} else {
	echo "header number 4 / index 3 is not defined';
}

If the measure header number 4 exists, $header is containing a MeasureHeader. Otherwise, it’s a null value.

^ Table of contents

getMeasureHeaders()

This method returns an array of MeasureHeader resources.

These are all measure headers.

Type

[]\PhpTabs\Music\MeasureHeader

Example

$tab = new PhpTabs('mytabs.gp4');

// Get all measure headers
$headers = $tab->getMeasureHeaders();

// Print number and index for all measure headers 
foreach ($headers as $index => $header) {
	echo sprintf(
		"\nHeader number=%d, index=%d",
		$header->getNumber(),
		$index
	);
}

will ouput something like:

Header number=1, index=0
Header number=2, index=1
Header number=3, index=2
Header number=4, index=3

^ Table of contents

countChannels()

This method returns the number of channels contained by the Song resource.

Type

integer

Example

$tab = new PhpTabs('mytabs.gp4');

// Count channels
echo $tab->countChannels();

// Print something like 4 if there is four types of instruments

^ Table of contents

getChannel($index)

This method returns a Channel resource.

Parameters

integer $index

Type

\PhpTabs\Music\Channel

Example

$tab = new PhpTabs('mytabs.gp4');

// Get the second channel
$channel = $tab->getChannel(1);

if ($channel !== null) {
	echo $channel->getChannelId();
} else {
	echo "Channel at index 1 is not defined';
}

^ Table of contents

getChannelById($channelId)

This method returns a Channel resource.

Parameters

integer $channelId

Type

\PhpTabs\Music\Channel

Example

$tab = new PhpTabs('mytabs.gp4');

// Is there any channel using a Piano?
$channel = $tab->getChannelById(0);

if ($channel !== null) {
	echo "Yes";
} else {
	echo "No;
}

^ Table of contents

getChannels()

This method returns an array of Channel resources.

These are all channels.

Type

[]\PhpTabs\Music\Channel

Example

$tab = new PhpTabs('mytabs.gp4');

// Get all channels
$channels = $tab->getChannels();

// Print channelId and volume for all channels
foreach ($channels as $index => $channel) {
	echo sprintf(
		"\nChannel index=%d, id=%d, volume=%d",
		$index,
		$channel->getChannelId(),
		$channel->getVolume()
	);
}

will ouput something like:

Channel index=0, id=28, volume=127
Channel index=1, id=0, volume=65

^ Table of contents

countTracks()

This method returns the number of tracks contained by the Song resource.

Type

integer

Example

$tab = new PhpTabs('mytabs.gp4');

// Count tracks
echo $tab->countTracks();

// Print something like 2 if there is 2 tracks

^ Table of contents

getTrack($index)

This method returns a Track resource.

Parameters

integer $index

Type

\PhpTabs\Music\Track

Example

$tab = new PhpTabs('mytabs.gp4');

// Is the first track using a Piano channel?
$track = $tab->getTrack(0);

if ($track->getChannelId() == 0) {
	echo "Yes";
} else {
	echo "No;
}

^ Table of contents

getTracks()

This method returns an array of tracks contained by the Song resource.

Type

[]\PhpTabs\Music\Track

Example

Let’s print the channel id for all tracks

$tab = new PhpTabs('mytabs.gp4');

foreach($tab->getTracks() as $track) {
	echo sprintf(
		"\nTrack %d, channel %d",
		$track->getNumber(),
		$track->getChannelId()
	);
}

will ouput something like:

Track 1, channel 28
Track 2, channel 0

^ Table of contents

Accessing properties

getName()

This method returns the name of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getName();

// Will output "My song name"

^ Table of contents

getAlbum()

This method returns the album of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getAlbum();

// Will output "My song album name"

^ Table of contents

getAuthor()

This method returns the author of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getAuthor();

// Will output "Author name"

^ Table of contents

getArtist()

This method returns the artist of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getArtist();

// Will output "Artist name"

^ Table of contents

getDate()

This method returns the date of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getDate();

// Will output "12/12/2012"

^ Table of contents

getCopyright()

This method returns the copyright of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getCopyright();

// Will output a string which represents licensing conditions

^ Table of contents

getWriter()

This method returns the writer of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getWriter();

// Will output "Writer name"

^ Table of contents

getTranscriber()

This method returns the transcriber of the song.

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getTranscriber();

// Will output "Transcriber name"

^ Table of contents

getComments()

This method returns comments (multiple lines).

Type

string

Example

$tab = new PhpTabs('mytabs.gp4');

echo $tab->getComments();

// Will output "Comment line 1\nComment line 2"

^ Table of contents

isEmpty()

This method returns true if the song has not any measure header or tracks.

Otherwise, it returns false.

Type

boolean

Example

$tab = new PhpTabs('mytabs.gp4');

if ($tab->isEmpty()) {
  echo "Empty song";
} else {
  echo "Song has at least one measure header and one track";
}

^ Table of contents

Updating children

addTrack($track)

This method adds a new Track at the end of the stack.

Parameters

\PhpTabs\Music\Track $track

Example

use PhpTabs\Music\TabString;
use PhpTabs\Music\Track;

$tab   = new PhpTabs('mytabs.gp4');

$track = new Track();

// Attach a song
$track->setSong($tab->getSong());
// Set at the end
$track->setNumber($tab->countTracks() + 1);
// Set a name
$track->setName('My track name');

// Prepare a one-string instrument
$string = new TabString();
$string->setNumber(1);
$string->setValue(34);
$track->addString($string);

// Add the new track
$tab->addTrack($track);

^ Table of contents

moveTrack($index, $track)

This method moves a Track from its last position to the given index.

Parameters

integer $index
\PhpTabs\Music\Track $track

Example

In this example, the first track will be put at the last position.

$tab   = new PhpTabs('mytabs.gp4');

$track = $tab->getTrack(0);
$index = $tab->countTracks() - 1;

$tab->moveTrack($index, $track);

^ Table of contents

removeTrack($track)

This method removes and clears the given Track.

Parameters

\PhpTabs\Music\Track $track

Example

In this example, all tracks will be removed.

$tab   = new PhpTabs('mytabs.gp4');

foreach ($tab->getTracks() as $track) {
  $tab->removeTrack($track);
}

^ Table of contents

addChannel($channel)

This method adds a new Channel at the end of the stack.

Parameters

\PhpTabs\Music\Channel $channel

Example

In this example, a new channel will be added with default configuration.

use Phptabs\Music\Channel;

$tab = new PhpTabs('mytabs.gp4');

$channel = new Channel();
$channel->setChannelId(
  $tab->countChannels() + 1
);

$tab->addChannel($channel);

^ Table of contents

moveChannel($index, $channel)

This method moves Channel to an index position.

Parameters

integer $index
\PhpTabs\Music\Channel $channel

Example

In this example, the last channel will be moved to the first position.

$tab = new PhpTabs('mytabs.gp4');

// Get the last defined channel
$channel = $tab->getChannel(
  $tab->countChannels() - 1
);

// Set at the first position
$tab->moveChannel(0, $channel);

^ Table of contents

removeChannel($channel)

This method removes a Channel.

Parameters

\PhpTabs\Music\Channel $channel

Example

In this example, the first channel will be removed.

$tab = new PhpTabs('mytabs.gp4');

// Get a channel
$channel = $tab->getChannel(0);

// Remove it
$tab->removeChannel($channel);

^ Table of contents

addMeasureHeader($measureHeader)

This method adds a new measure header at the end of the stack.

Parameters

\PhpTabs\Music\MeasureHeader $measureHeader

Example

$tab = new PhpTabs('mytabs.gp4');

$measureHeader = new MeasureHeader();
$measureHeader->setNumber(
  $tab->countMeasureHeaders()
);

// Add the new header
$tab->addMeasureHeader($measureHeader);

^ Table of contents

removeMeasureHeader($index)

This method removes a MeasureHeader at given index.

Parameters

int $index

Example

In this example, the first measure header will be removed.

$tab = new PhpTabs('mytabs.gp4');

$tab->removeMeasureHeader(0);

^ Table of contents

Updating properties

setName($name)

This method sets the name attribute.

Parameters

string $name

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setName('My new song title');

^ Table of contents

setAlbum($album)

This method sets the album attribute.

Parameters

string $album

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setAlbum('My new album title');

^ Table of contents

setAuthor($author)

This method sets the author attribute.

Parameters

string $author

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setAuthor('My new author name');

^ Table of contents

setArtist($artist)

This method sets the artist attribute.

Parameters

string $artist

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setArtist('My new artist name');

^ Table of contents

setDate($date)

This method sets the date attribute.

Parameters

string $date

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setDate('12/12/2012');

^ Table of contents

setCopyright($copyright)

This method sets the copyright attribute.

Parameters

string $copyright

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setCopyright('License LGPL2.1+');

^ Table of contents

setWriter($writer)

This method sets the writer attribute.

Parameters

string $writer

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setWriter('Writer name');

^ Table of contents

setTranscriber($transcriber)

This method sets the transcriber attribute.

Parameters

string $transcriber

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setTranscriber('Transcriber name');

^ Table of contents

setComments($comments)

This method sets the comments attribute.

Parameters

string $comments

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->setComments('Comment line 1
Comment line 2
Etc...');

^ Table of contents

clear()

This method clears all channels, measure headers and tracks.

Example

$tab = new PhpTabs('mytabs.gp4');

$tab->clear();

^ Table of contents

copyFrom($song)

This method converts all data of a given song into internal data.

Parameters

\PhpTabs\Music\Song $song

Example

In this example, an empty song will replace actual data.

$tab = new PhpTabs('mytabs.gp4');

$tab->copyFrom(new Song());

^ Table of contents

Edit this document on GitHub