Initial commit

[andy/gpx.git] / src / libgpx / libxmlexception.php

<?php
/**
 * libxmlexception.php
 *
 * Copyright 2018 Andy Street <andy@street.me.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 *
 *
 */

namespace libgpx;

use \LibXMLError;
use \RuntimeException;

/**
 * An exception triggered by a libxml error.
 *
 * @author Andy Street <andy@street.me.uk>
 */
class LibXMLException extends RuntimeException
{

  /**
   * The error that triggered this exception.
   *
   * @var LibXMLError
   */
  protected $xmlError;

  /**
   * Create a new exception.
   *
   * @param LibXMLError $error The error that triggered this exception.
   */
  public function __construct(LibXMLError $error)
  {
    parent::__construct($error->message, $error->code);
    $this->xmlError = $error;
  }

  /**
   * Fetch the error that triggered this exception.
   *
   * @return LibXMLError The error.
   */
  public function getLibXMLError()
  {
    return $this->xmlError;
  }

}