Net_MPD
[ class tree: Net_MPD ] [ index: Net_MPD ] [ all elements ]

Class: Net_MPD_Database

Source Location: /Net_MPD-1.0.2/Net/MPD/Database.php

Class Overview

Net_MPD_Common
   |
   --Net_MPD_Database

API for the database portion of Music Player Daemon commands


Author(s):

Version:

  • CVS: $ID:$

Copyright:

  • 2006 Graham Christensen

Methods


Inherited Variables

Inherited Methods

Class: Net_MPD_Common

Net_MPD_Common::__construct()
Set connection params
Net_MPD_Common::connect()
Connect to MPD
Net_MPD_Common::disconnect()
Disconnect from MPD
Net_MPD_Common::getCommands()
Used to discover which commands are available
Net_MPD_Common::getErrorData()
Get the current error data
Net_MPD_Common::getErrors()
A method to access errors
Net_MPD_Common::getNotCommands()
Used to discover commands that are not available
Net_MPD_Common::getStats()
Get various statistics about the MPD server
Net_MPD_Common::getStatus()
Get the status of the MPD server
Net_MPD_Common::isConnected()
Check connection status
Net_MPD_Common::parseOutput()
Parse MPD output on a line-by-line basis creating output that is easy to work with
Net_MPD_Common::ping()
Ping the MPD server to keep the connection running
Net_MPD_Common::read()
Read data from the socket
Net_MPD_Common::runCommand()
Run command
Net_MPD_Common::write()
Write data to the socket

Class Details

[line 46]
API for the database portion of Music Player Daemon commands

Used for maintaining and working with the MPD database



[ Top ]


Method Detail

find   [line 55]

array find( array $params, [bool $caseSensitive = false])

Case sensitive search for data in the database
  • Access: public

Parameters:

array   $params   —  array('search_field' => 'search for')
bool   $caseSensitive   —  True for case sensitivity, false for not [default false]

[ Top ]

getAll   [line 109]

array getAll( [$dir $dir = ''])

Lists all files and folders in the directory recursively
  • Access: public

Parameters:

$dir   $dir   —  string directory to start in, optional

[ Top ]

getAllInfo   [line 122]

array getAllInfo( [$dir $dir = ''])

Lists all files/folders recursivly, listing any related informaiton
  • Access: public

Parameters:

$dir   $dir   —  string directory to start in, optional

[ Top ]

getInfo   [line 133]

array getInfo( [$dir $dir = ''])

Lists content of the directory
  • Access: public

Parameters:

$dir   $dir   —  string directory to work in, optional

[ Top ]

getMetadata   [line 82]

array getMetadata( string $metadata1, [string $metadata2 = null], [string $search = null])

List all metadata of matches to the search
  • Access: public

Parameters:

string   $metadata1   —  metadata to list
string   $metadata2   —  metadata field to search in, optional
string   $search   —  data to search for in search field, required if search field provided

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:21:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.