Class: Xinc_Exception_IO

Source Location: /Xinc/Exception/IO.php

Class Overview

Exception
   |
   --Xinc_Exception_IO

Xinc - Continuous Integration.

Author(s):

Alexander Opitz <opitz.alexander@gmail.com>

Copyright:

2012 Alexander Opitz, Leipzig

Constants

Methods

Inherited Variables

Class: Exception (Internal Class)

$code
$file
$line
$message
$previous
$string
$trace

Inherited Methods

Class: Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )

Class Details

[line 32]
Xinc - Continuous Integration.

Exception, for file IO problems.

PHP version 5

Tags:

author:	Alexander Opitz <opitz.alexander@gmail.com>
copyright:	2012 Alexander Opitz, Leipzig
link:	http://code.google.com/p/xinc/
license:	GNU/LGPL, see license.php This file is part of Xinc. Xinc 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 2.1 of the License, or (at your option) any later version. Xinc 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 Xinc, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

[ Top ]

Class Methods

constructor __construct [line 58]

Xinc_Exception_IO __construct(
string
$strResourceName, [string
$strResourcePath = null], [string
$strMessage = null], [integer
$nCode = self::FAILURE_IO], [Exception
$previous = null])

Constructor, generates an Exception Message

Tags:

access:

public

Overrides Exception::constructor __construct ( [$message = ], [$code = ], [$previous = ] ) (parent method not documented)

Parameters:

string	$strResourceName	Name of directory/file/stream that failed.
string	$strResourcePath	Path of directory/file/stream that failed.
string	$strMessage	Exception message.
integer	$nCode	Code of failure from this consts.
Exception	$previous	Exception if nested exception.

[ Top ]

method getErrorMessage [line 95]

string getErrorMessage(
[string
$strMessage = null], integer
$nCode)

Builds and returns an error message for this exception.

Tags:

return:	A message for this error.
access:	protected

Parameters:

string	$strMessage	Exception message.
integer	$nCode	Code of failure from this consts.

[ Top ]

method getResourceName [line 72]

string getResourceName(
)

Returns the name of the failed resource.

Tags:

return:	The name of the resource that failed.
access:	public

[ Top ]

method getResourcePath [line 82]

string getResourcePath(
)

Returns the path of the failed resource.

Tags:

return:	The path of the resource that failed.
access:	public

[ Top ]

Class Constants

FAILURE_IO = 1

[line 34]

[ Top ]

FAILURE_NOT_FOUND = 4

[line 37]

[ Top ]

FAILURE_NOT_READABLE = 3

[line 36]

[ Top ]

FAILURE_NOT_WRITEABLE = 2

[line 35]

[ Top ]

Documentation generated on Sun, 09 Dec 2012 21:49:28 +0100 by phpDocumentor 1.4.4