/class/util/RegisteredCharacter.php

<?php
/**
 * Contains RegisteredCharacter class.
 *
 * PHP version 5
 *
 * LICENSE: This file is part of Yet Another Php Eve Api library also know
 * as Yapeal which will be used to refer to it in the rest of this license.
 *
 *  Yapeal is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Yapeal is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Yapeal. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author     Michael Cummings <mgcummings@yahoo.com>
 * @copyright  Copyright (c) 2008-2012, Michael Cummings
 * @license    http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @package    Yapeal
 * @link       http://code.google.com/p/yapeal/
 * @link       http://www.eveonline.com/
 */
/**
 * @internal Allow viewing of the source code in web browser.
 */
if (isset($_REQUEST['viewSource'])) {
  highlight_file(__FILE__);
  exit();
};
/**
 * @internal Only let this code be included.
 */
if (count(get_included_files()) < 2) {
  $mess = basename(__FILE__)
    . ' must be included it can not be ran directly.' . PHP_EOL;
  if (PHP_SAPI != 'cli') {
    header('HTTP/1.0 403 Forbidden', TRUE, 403);
    die($mess);
  };
  fwrite(STDERR, $mess);
  exit(1);
};
/**
 * Wrapper class for utilRegisteredCharacter table.
 *
 * @package Yapeal
 * @subpackage Wrappers
 */
class RegisteredCharacter extends ALimitedObject implements IGetBy {
  /**
   * Hold an instance of the AccessMask class.
   * @var object
   */
  protected $am;
  /**
   * Holds an instance of the DB connection.
   * @var object
   */
  protected $con;
  /**
   * Holds the table name of the query is being built.
   * @var string
   */
  protected $tableName;
  /**
   * Holds query builder object.
   * @var object
   */
  protected $qb;
  /**
   * Set to TRUE if a database record exists.
   * @var bool
   */
  private $recordExists;
  /**
   * Constructor
   *
   * @param mixed $id Id of Character wanted.
   * @param bool $create When $create is set to FALSE will throw DomainException
   * if $id doesn't exist in database.
   *
   * @throws InvalidArgumentException If $id isn't a number or string throws an
   * InvalidArgumentException.
   * @throws DomainException If $create is FALSE and a database record for $id
   * doesn't exist a DomainException will be thrown.
   */
  public function __construct($id = NULL, $create = TRUE) {
    $this->tableName = YAPEAL_TABLE_PREFIX . 'util' . __CLASS__;
    try {
      // Get a database connection.
      $this->con = YapealDBConnection::connect(YAPEAL_DSN);
    }
    catch (ADODB_Exception $e) {
      $mess = 'Failed to get database connection in ' . __CLASS__;
      throw new RuntimeException($mess);
    }
    // Get a new access mask object.
    $this->am = new AccessMask();
    // Get a new query builder object.
    $this->qb = new YapealQueryBuilder($this->tableName, YAPEAL_DSN);
    // Get a list of column names and their ADOdb generic types.
    $this->colTypes = $this->qb->getColumnTypes();
    // Was $id set?
    if (!empty($id)) {
      // If $id has any characters other than 0-9 it's not a characterID.
      if (0 == strlen(str_replace(range(0, 9), '', $id))) {
        if (FALSE === $this->getItemById($id)) {
          if (TRUE == $create) {
            // If $id is a number and doesn't exist yet set characterID with it.
            $this->properties['characterID'] = $id;
          } else {
            $mess = 'Unknown character ' . $id;
            throw new DomainException($mess);
          };// else ...
        };
        // else if it's a string ...
      } else if (is_string($id)) {
        if (FALSE === $this->getItemByName($id)) {
          if (TRUE == $create) {
            // If $id is a string and doesn't exist yet set name with it.
            $this->properties['characterName'] = $id;
          } else {
            $mess = 'Unknown character ' . $id;
            throw new DomainException($mess);
          };// else ...
        };
      } else {
        $mess = 'Parameter $id must be an integer or a string';
        throw new InvalidArgumentException($mess);
      };// else ...
    };// if !empty $id ...
  }// function __construct
  /**
   * Destructor used to make sure to release ADOdb resource correctly more for
   * peace of mind than actual need.
   */
  public function __destruct() {
    $this->con = NULL;
  }// function __destruct
  /**
   * Used to add an API to the list in activeAPIMask.
   *
   * @param string $name Name of the API to add without 'char' part i.e.
   * 'charAccountBalance' would just be 'AccountBalance'
   *
   * @return bool Returns TRUE if $name already exists else FALSE.
   *
   * @throws DomainException Throws DomainException if $name could not be found.
   */
  public function addActiveAPI($name) {
    $mask = $this->am->apisToMask($name, 'char');
    if (($this->properties['activeAPIMask'] & $mask) > 0) {
      $ret = TRUE;
    } else {
      $this->properties['activeAPIMask'] |= $mask;
      $ret = FALSE;
    };// if $this->properties['activeAPIMask'] ...
    return $ret;
  }// function addActiveAPI
  /**
   * Used to delete an API from the list in activeAPIMask.
   *
   * @param string $name Name of the API to delete without 'char' part i.e.
   * 'charAccountBalance' would just be 'AccountBalance'
   *
   * @return bool Returns TRUE if $name was already set else FALSE.
   *
   * @throws DomainException Throws DomainException if $name could not be found.
   */
  public function deleteActiveAPI($name) {
    $mask = $this->am->apisToMask($name, 'char');
    if (($this->properties['activeAPIMask'] & $mask) > 0) {
      $this->properties['activeAPIMask'] ^= $mask;
      $ret = TRUE;
    } else {
      $ret = FALSE;
    };// if $this->properties['activeAPIMask'] ...
    return $ret;
  }// function deleteActiveAPI
  /**
   * Used to get user from utilRegisteredCharacter table by char ID.
   *
   * @param $id Id of Character wanted.
   *
   * @return bool TRUE if char was retrieved.
   */
  public function getItemById($id) {
    $sql = 'select `' . implode('`,`', array_keys($this->colTypes)) . '`';
    $sql .= ' from `' . $this->tableName . '`';
    $sql .= ' where `characterID`=' . $id;
    try {
      $result = $this->con->GetRow($sql);
      if (!empty($result)) {
        $this->properties = $result;
        $this->recordExists = TRUE;
      } else {
        $this->recordExists = FALSE;
        // Get new mask from section.
        $sql = 'select `activeAPIMask`';
        $sql .= ' from `' . YAPEAL_TABLE_PREFIX . 'utilSections`';
        $sql .= ' where `section` = "char"';
        $result = $this->con->GetOne($sql);
        $this->properties['activeAPIMask'] = (string)$result;
        // Get characterName from accountCharacter if available.
        $sql = 'select `characterName`';
        $sql .= ' from `' . YAPEAL_TABLE_PREFIX . 'accountCharacters`';
        $sql .= ' where `characterID`=' . $id;
        $result = $this->con->GetOne($sql);
        if (!empty($result)) {
          $this->properties['characterName'] = (string)$result;
        };
      };
    }
    catch (ADODB_Exception $e) {
      Logger::getLogger('yapeal')->warn($e);
      $this->recordExists = FALSE;
    }
    return $this->recordExists();
  }// function getItemById
  /**
   * Used to get item from table by name.
   *
   * @param $name Name of record wanted.
   *
   * @return bool TRUE if item was retrieved else FALSE.
   */
  public function getItemByName($name) {
    $sql = 'select `' . implode('`,`', array_keys($this->colTypes)) . '`';
    $sql .= ' from `' . $this->tableName . '`';
    try {
      $sql .= ' where `characterName`=' . $this->con->qstr($name);
      $result = $this->con->GetRow($sql);
      if (!empty($result)) {
        $this->properties = $result;
        $this->recordExists = TRUE;
      } else {
        $this->recordExists = FALSE;
        // Get new mask from section.
        $sql = 'select `activeAPIMask`';
        $sql .= ' from `' . YAPEAL_TABLE_PREFIX . 'utilSections`';
        $sql .= ' where `section` = "char"';
        $result = $this->con->GetOne($sql);
        $this->properties['activeAPIMask'] = (string)$result;
        // Get characterID from accountCharacter if available.
        $sql = 'select `characterID`';
        $sql .= ' from `' . YAPEAL_TABLE_PREFIX . 'accountCharacters`';
        $sql .= ' where `characterName`=' . $name;
        $result = $this->con->GetOne($sql);
        if (!empty($result)) {
          $this->properties['characterID'] = (string)$result;
        };
      };
    }
    catch (ADODB_Exception $e) {
      Logger::getLogger('yapeal')->warn($e);
      $this->recordExists = FALSE;
    }
    return $this->recordExists();
  }// function getItemByName
  /**
   * Function used to check if database record already existed.
   *
   * @return bool Returns TRUE if the the database record already existed.
   */
  public function recordExists() {
    return $this->recordExists;
  }// function recordExists
  /**
   * Used to set default for column.
   *
   * @param string $name Name of the column.
   * @param mixed $value Value to be used as default for column.
   *
   * @return bool Returns TRUE if column exists in table and default was set.
   */
  public function setDefault($name, $value) {
    return $this->qb->setDefault($name, $value);
  }// function setDefault
  /**
   * Used to set defaults for multiple columns.
   *
   * @param array $defaults List of column names and new default values.
   *
   * @return bool Returns TRUE if all column defaults could be set, else FALSE.
   */
  public function setDefaults(array $defaults) {
    return $this->qb->setDefaults($defaults);
  }// function setDefaults
  /**
   * Used to store data into table.
   *
   * @return bool Return TRUE if store was successful.
   */
  public function store() {
    if (FALSE === $this->qb->addRow($this->properties)) {
      return FALSE;
    };// if FALSE === ...
    return $this->qb->store();
  }// function store
}
?>