fPanel::Database

• NAME
• DESCRIPTION
• METHODS
  • new ()
  • loadConfig( [$config] )
  • connect ()
  • getDomains ()
  • getDomainByFQDN ($fqdn)
  • getDomainByID ($domainid)
  • deleteDomain ($domainid)
  • getUsers ()
  • getUserByUsername ($username)
  • getUser ($userid)
  • deleteUser ($userid)
  • insertDomain ($domain)
  • insertUser ($user)
  • disconnect ()
• INTERNAL METHODS
  • _selectQuery ($query, [ @blanks ])
  • _nonSelectQuery ($query, [ @blanks ])
  • _rawToDomain ($rawdomain)
  • _rawToUser ($rawuser)
• AUTHOR

NAME

fPanel::Database - fPanel database handler

DESCRIPTION

This module is your frontend to the fPanel database. It has only been tested with MySQL as of now, but you can insert your own DSN, if you wish, so compatible data sources might work as well.

METHODS

new ()

This method creates a new fPanel::Database object. It does not load configuration nor connect to the database. This happens automatically when you request information, if it hasn't been done yet. This is because now you can give alternative configuration before connecting. For example, you might give your own fPanel::Config compatible object and fPanel::Database will be happy to work with it.

loadConfig( [$config] )

This method is called automatically to load a default fPanel::Config object. If you want an alternative configuration object, call this object yourself and give the object as the first argument.

connect ()

This method is called automatically to connect to the database, after loading the configuration.

getDomains ()

This method gets all domains from the database and returns them as fPanel::Domain objects.

getDomainByFQDN ($fqdn)

This method gets a specific domain from the database based on its FQDN and returns it as an fPanel::Domain object. If no domain exists with this fqdn, undef is returned.

getDomainByID ($domainid)

This method gets a specific domain from the database based on its ID and returns it as an fPanel::Domain object. If no domain exists with this domainid, undef is returned.

deleteDomain ($domainid)

This method removes a domain from the database.

getUsers ()

This method gets all users from the database and returns them as fPanel::User objects.

getUserByUsername ($username)

This method gets a specific user from the database and returns it as an fPanel::User object. If no user exists with this username, undef is returned.

getUser ($userid)

This method gets a specific user from the database and returns it as an fPanel::User object. If no user exists with this userid, undef is returned.

deleteUser ($userid)

This method removes a user from the database.

insertDomain ($domain)

This method inserts $domain which is an fPanel::Domain object, to the database.

This method as of now inserts to both the vhosts table and the domains table for backwards compatibility.

After inserting the domain, the id in the object will be set to the inserted id. Also, the user as pointed to by the 'userid', should already exist, so call insertUser first. The inserted id will be returned.

insertUser ($user)

This method inserts $user which is an fPanel::User object, to the database.

disconnect ()

Disconnect from the database.

INTERNAL METHODS

You may of course call these, but you are definitely not recommended to do so.

_selectQuery ($query, [ @blanks ])

This method runs a SELECT query (or similar, such as SHOW) and returns the rows as an array. @blanks are inserted in the parameters ('?'). Leave empty if you have none.

_nonSelectQuery ($query, [ @blanks ])

This method runs a non-SELECT query and returns the result.

_rawToDomain ($rawdomain)

This method turns raw domain data from the database into an fPanel::Domain object.

_rawToUser ($rawuser)

This method turns raw user data from the database into an fPanel::User object.

AUTHOR

Written by Sjors Gielen, <dazjorz@dazjorz.com>.