Source for file standardManiacode.php

Documentation is available at standardManiacode.php

<?php
/**
* @author Philippe Melot
* @package ManiaLib
*/
/**
* Maniacode Toolkit base component
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
abstract class ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName;
protected $xml;
protected $name;
/**#@-*/
/**
* This method sets the Name of the file once download
*
* @param string $name The name of the file once download
* @return void
*
*/
function setName($name)
{
$this->name = $name;
}
/**
* This method gets the Name of the element
*
* @return string This return the name of the file once download
*
*/
function getName()
{
return $this->name;
}
protected function preFilter() {}
protected function postFilter() {}
final function save()
{
$this->preFilter();
$this->xml = Maniacode::$domDocument->createElement($this->xmlTagName);
end(Maniacode::$parentNodes)->appendChild($this->xml);
if (isset($this->name))
{
$elem = Maniacode::$domDocument->createElement('name');
$value = Maniacode::$domDocument->createTextNode($this->name);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
$this->postFilter();
}
}
/**
* File download
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
abstract class FileDownload extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $url;
/**#@-*/
function __construct($name = '', $url = '')
{
$this->name = $name;
$this->url = $url;
}
/**
* This method sets the url to download the file
*
* @param string $url The url to download the file
* @return void
*
*/
function setUrl($url)
{
$this->url = $url;
}
/**
* This method gets the Url of the element
*
* @return void
*
*/
function getUrl()
{
return $this->url;
}
protected function postFilter()
{
if (isset($this->url))
{
$elem = Maniacode::$domDocument->createElement('url');
$value = Maniacode::$domDocument->createTextNode($this->url);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Install track
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class InstallTrack extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'install_track';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* Play track
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class PlayTrack extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'play_track';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* Package track
* Use it only with InstallTrackPack
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class PackageTrack extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'track';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* Install track pack
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class InstallTrackPack extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'install_track_pack';
protected $tracks = array();
/**#@-*/
function __construct($name='')
{
$this->name = $name;
}
function addTrack($name = '', $url = '')
{
$this->tracks[] = new PackageTrack($name, $url);
}
function getLastInsert()
{
return end($this->tracks);
}
protected function postFilter()
{
if (isset($this->tracks) && is_array($this->tracks) && count($this->tracks))
{
foreach ($this->tracks as $track)
{
$track->save();
}
}
}
}
/**
* Install replay
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class InstallReplay extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'install_replay';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* View replay
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class ViewReplay extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'view_replay';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* Play replay
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class PlayReplay extends FileDownload
{
/**
* @ignore
*/
protected $xmlTagName = 'play_replay';
function __construct($name='', $url='')
{
parent::__construct($name, $url);
}
}
/**
* Install skin
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class InstallSkin extends FileDownload
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'install_skin';
protected $file;
/**#@-*/
function __construct($name='', $file='', $url='')
{
parent::__construct($name, $url);
$this->setFile($file);
}
/**
* This method sets the path to install the skin
*
* @param string $file The path to the skin
* @return void
*
*/
public function setFile($file)
{
$this->file = $file;
}
/**
* This method gets the path to install the skin
*
* @return string The path to the skin
*
*/
public function getFile()
{
return $this->file;
}
protected function postFilter()
{
if (isset($this->file))
{
$elem = Maniacode::$domDocument->createElement('file');
$value = Maniacode::$domDocument->createTextNode($this->file);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Get skin
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class GetSkin extends InstallSkin
{
/**
* @ignore
*/
protected $xmlTagName = 'get_skin';
function __construct($name='', $file='', $url='')
{
parent::__construct($name, $file, $url);
}
}
/**
* Show message
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class ShowMessage extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'show_message';
protected $message;
/**#@-*/
function __construct($message = 'This is a default message provided by Manialib')
{
$this->setMessage($message);
}
function setMessage($message)
{
$this->message = $message;
}
function getMessage()
{
return $this->message;
}
function postFilter()
{
if ($this->message)
{
$elem = Maniacode::$domDocument->createElement('message');
$value = Maniacode::$domDocument->createTextNode($this->message);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Goto link
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class GotoLink extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'goto';
protected $link;
/**#@-*/
function __construct($link = 'manialib')
{
$this->setLink($link);
}
function setLink($link)
{
$this->link = $link;
}
function getLink()
{
return $this->link;
}
protected function postFilter()
{
if (isset($this->link))
{
$elem = Maniacode::$domDocument->createElement('link');
$value = Maniacode::$domDocument->createTextNode($this->link);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Join server
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class JoinServer extends ManiacodeComponent
{
/**#@+
* Connection type
*/
const PLAY = 1;
const SPEC = 2;
const REFEREE = 3;
/**#@-*/
/**#@+
* @ignore
*/
protected $xmlTagName = 'join_server';
protected $ip;
protected $password;
protected $connectionType;
/**#@-*/
function __construct($connectionType = self::PLAY)
{
$this->connectionType = $connectionType;
}
function setIp($ip)
{
$this->ip = $ip;
}
function getIp()
{
return $this->ip;
}
function setPassword($password)
{
$this->password = $password;
}
function getPassword()
{
return $this->password;
}
function setConnectionType($connection)
{
$this->connectionType = $connection;
}
function getConnectionType()
{
return $this->connectionType;
}
protected function postFilter()
{
if (isset($this->ip))
{
$elem = Maniacode::$domDocument->createElement('ip');
$value = Maniacode::$domDocument->createTextNode($this->ip);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
if (isset($this->password))
{
$elem = Maniacode::$domDocument->createElement('password');
$value = Maniacode::$domDocument->createTextNode($this->password);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
if (isset($this->connectionType))
{
$elem = Maniacode::$domDocument->createElement('connection_type');
$value = Maniacode::$domDocument->createTextNode($this->connectionType);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Add buddy
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class AddBuddy extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'add_buddy';
protected $login;
/**#@-*/
function __construct($login)
{
$this->login = $login;
}
function setLogin($login)
{
$this->login = $login;
}
function getLogin()
{
return $this->login;
}
protected function postFilter()
{
if (isset($this->login))
{
$elem = Maniacode::$domDocument->createElement('login');
$value = Maniacode::$domDocument->createTextNode($this->login);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Invite buddy
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class InviteBuddy extends ManiacodeComponent
{
/**#@+
* @ignore
*/
protected $xmlTagName = 'invite_buddy';
protected $email;
/**#@-*/
function __construct($email = '')
{
$this->email = $email;
}
function setEmail($email)
{
$this->email = $email;
}
function getEmail()
{
return $this->email;
}
protected function postFilter()
{
if (isset($this->email))
{
$elem = Maniacode::$domDocument->createElement('email');
$value = Maniacode::$domDocument->createTextNode($this->email);
$elem->appendChild($value);
$this->xml->appendChild($elem);
}
}
}
/**
* Add favorite
* @package ManiaLib
* @subpackage ManiacodeToolkit
*/
class AddFavourite extends AddBuddy
{
/**
* @ignore
*/
protected $xmlTagName = 'add_favourite';
function __construct($login)
{
parent::__construct($login);
}
}
?>

ManiaLib 1.0b1 API Reference

Source for file standardManiacode.php