This repository has been archived by the owner on Feb 1, 2020. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
338 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Namespaces | ||
========== | ||
|
||
This is a complete list of available namespaces: | ||
|
||
- [`Phine`](Phine) | ||
- [`Phine\Test`](Phine/Test) | ||
- [`Phine\Test\Exception`](Phine/Test/Exception) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Classes | ||
======= | ||
|
||
This is a complete list of available classes: | ||
|
||
- [`Phine\Test\Exception\MethodException`](Phine/Test/Exception/MethodException.md) — Exception thrown for class property related errors. | ||
- [`Phine\Test\Exception\PropertyException`](Phine/Test/Exception/PropertyException.md) — Exception thrown for class property related errors. | ||
- [`Phine\Test\Exception\TempException`](Phine/Test/Exception/TempException.md) — Exception thrown for temporary file system related errors. | ||
- [`Phine\Test\Method`](Phine/Test/Method.md) — Manages access to a protected or private class method. | ||
- [`Phine\Test\Property`](Phine/Test/Property.md) — Manages access to a protected or private class property. | ||
- [`Phine\Test\Temp`](Phine/Test/Temp.md) — Manages a collection of temporary file system paths. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Interfaces | ||
========== | ||
|
||
This is a complete list of available interfaces: | ||
|
||
- There are no interfaces available. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<small>Phine\Test\Exception</small> | ||
|
||
MethodException | ||
=============== | ||
|
||
Exception thrown for class property related errors. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
- It is a subclass of `Phine\Exception\Exception`. | ||
|
||
Methods | ||
------- | ||
|
||
The class defines the following methods: | ||
|
||
- [`notExist()`](#notExist) — Creates a new exception for a method that does not exist. | ||
|
||
### `notExist()` <a name="notExist"></a> | ||
|
||
Creates a new exception for a method that does not exist. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of the method. | ||
- _Returns:_ A new exception. | ||
- [`PropertyException`](../../../Phine/Test/Exception/PropertyException.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<small>Phine\Test\Exception</small> | ||
|
||
PropertyException | ||
================= | ||
|
||
Exception thrown for class property related errors. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
- It is a subclass of `Phine\Exception\Exception`. | ||
|
||
Methods | ||
------- | ||
|
||
The class defines the following methods: | ||
|
||
- [`notExist()`](#notExist) — Creates a new exception for a property that does not exist. | ||
|
||
### `notExist()` <a name="notExist"></a> | ||
|
||
Creates a new exception for a property that does not exist. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of the property. | ||
- _Returns:_ A new exception. | ||
- [`PropertyException`](../../../Phine/Test/Exception/PropertyException.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<small>Phine\Test\Exception</small> | ||
|
||
TempException | ||
============= | ||
|
||
Exception thrown for temporary file system related errors. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
- It is a subclass of `Phine\Exception\Exception`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
<small>Phine\Test</small> | ||
|
||
Method | ||
====== | ||
|
||
Manages access to a protected or private class method. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
|
||
Methods | ||
------- | ||
|
||
The class defines the following methods: | ||
|
||
- [`find()`](#find) — Finds a method for the given class. | ||
- [`invoke()`](#invoke) — Invokes a method for the given class. | ||
- [`invokeArgs()`](#invokeArgs) — Invokes a method for the given class using a list of arguments. | ||
|
||
### `find()` <a name="find"></a> | ||
|
||
Finds a method for the given class. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of the method. | ||
- `$access` (`boolean`) — Make the method accessible? | ||
- _Returns:_ The method. | ||
- [`ReflectionMethod`](http://php.net/class.ReflectionMethod) | ||
- It throws one of the following exceptions: | ||
- `MethodException` — If the method does not exist. | ||
|
||
### `invoke()` <a name="invoke"></a> | ||
|
||
Invokes a method for the given class. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` | ||
- `$name` | ||
- _Returns:_ The result of the invocation. | ||
- `mixed` | ||
|
||
### `invokeArgs()` <a name="invokeArgs"></a> | ||
|
||
Invokes a method for the given class using a list of arguments. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of the method. | ||
- `$args` (`array`) — A list of method arguments to pass. | ||
- _Returns:_ The result of the invocation. | ||
- `mixed` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
<small>Phine\Test</small> | ||
|
||
Property | ||
======== | ||
|
||
Manages access to a protected or private class property. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
|
||
Methods | ||
------- | ||
|
||
The class defines the following methods: | ||
|
||
- [`find()`](#find) — Finds a property for the given class. | ||
- [`get()`](#get) — Returns the current value of a property. | ||
- [`set()`](#set) — Sets the new value of a property. | ||
|
||
### `find()` <a name="find"></a> | ||
|
||
Finds a property for the given class. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of a property. | ||
- `$access` (`boolean`) — Make the property accessible? | ||
- _Returns:_ The property. | ||
- [`ReflectionProperty`](http://php.net/class.ReflectionProperty) | ||
- It throws one of the following exceptions: | ||
- `PropertyException` — If the property does not exist. | ||
|
||
### `get()` <a name="get"></a> | ||
|
||
Returns the current value of a property. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of a property. | ||
- _Returns:_ The current value of the property. | ||
- `mixed` | ||
|
||
### `set()` <a name="set"></a> | ||
|
||
Sets the new value of a property. | ||
|
||
#### Signature | ||
|
||
- It is a **public static** method. | ||
- It accepts the following parameter(s): | ||
- `$class` (`object`|`string`) — The class instance or name. | ||
- `$name` (`string`) — The name of a property. | ||
- `$value` (`mixed`) — The new value. | ||
- It does not return anything. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
<small>Phine\Test</small> | ||
|
||
Temp | ||
==== | ||
|
||
Manages a collection of temporary file system paths. | ||
|
||
Signature | ||
--------- | ||
|
||
- It is a(n) **class**. | ||
|
||
Methods | ||
------- | ||
|
||
The class defines the following methods: | ||
|
||
- [`__construct()`](#__construct) — Sets the temporary directory path and path prefix. | ||
- [`copyDir()`](#copyDir) — Copies an existing directory to a temporary path. | ||
- [`copyFile()`](#copyFile) — Copies an existing file to a temporary path. | ||
- [`createDir()`](#createDir) — Returns a new temporary directory path. | ||
- [`createFile()`](#createFile) — Returns a new temporary file path. | ||
- [`purgePaths()`](#purgePaths) — Removes all created directory and file paths. | ||
|
||
### `__construct()` <a name="__construct"></a> | ||
|
||
Sets the temporary directory path and path prefix. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- It accepts the following parameter(s): | ||
- `$dir` (`string`) — The temporary directory path. | ||
- `$prefix` (`string`) — The temporary path prefix. | ||
- It does not return anything. | ||
|
||
### `copyDir()` <a name="copyDir"></a> | ||
|
||
Copies an existing directory to a temporary path. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- It accepts the following parameter(s): | ||
- `$dir` (`string`) — The directory to copy. | ||
- `$prefix` (`string`) — A path prefix. | ||
- _Returns:_ The temporary directory path. | ||
- `string` | ||
|
||
### `copyFile()` <a name="copyFile"></a> | ||
|
||
Copies an existing file to a temporary path. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- It accepts the following parameter(s): | ||
- `$file` (`string`) — The file to copy. | ||
- `$prefix` (`string`) — A path prefix. | ||
- _Returns:_ The temporary file path. | ||
- `string` | ||
- It throws one of the following exceptions: | ||
- [`Exception`](http://php.net/class.Exception) | ||
- `TempException` — If the file could not be copied. | ||
|
||
### `createDir()` <a name="createDir"></a> | ||
|
||
Returns a new temporary directory path. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- It accepts the following parameter(s): | ||
- `$prefix` (`string`) — A path prefix. | ||
- _Returns:_ The temporary directory path. | ||
- `string` | ||
- It throws one of the following exceptions: | ||
- [`Exception`](http://php.net/class.Exception) | ||
- `TempException` — If the path could not be created. | ||
|
||
### `createFile()` <a name="createFile"></a> | ||
|
||
Returns a new temporary file path. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- It accepts the following parameter(s): | ||
- `$prefix` (`string`) — A path prefix. | ||
- _Returns:_ The temporary file path. | ||
- `string` | ||
- It throws one of the following exceptions: | ||
- [`Exception`](http://php.net/class.Exception) | ||
- `TempException` — If the path could not be created. | ||
|
||
### `purgePaths()` <a name="purgePaths"></a> | ||
|
||
Removes all created directory and file paths. | ||
|
||
#### Signature | ||
|
||
- It is a **public** method. | ||
- _Returns:_ The total number of paths deleted. | ||
- `integer` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
0.8.1-DEV |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
C:19:"Sami\Renderer\Index":617:{a:3:{i:0;a:6:{s:36:"Phine\Test\Exception\MethodException";s:40:"676f1703071c994142702b466dac41e9d9ef3428";s:38:"Phine\Test\Exception\PropertyException";s:40:"123b8052d5480073e1c2079e5a58c2f96828f0cb";s:34:"Phine\Test\Exception\TempException";s:40:"da8f63c58ab2fdc65f06aaa0d6e9a2f1e7a485c4";s:17:"Phine\Test\Method";s:40:"96587396c9de04b698e479f6285c85f9cb979a0c";s:19:"Phine\Test\Property";s:40:"61d9fcf13d5eb5a9a60bfd2d7a5a5c51f53f8388";s:15:"Phine\Test\Temp";s:40:"2f69b2431fe497adf868a4e64062cdc8e3b7ccfc";}i:1;a:1:{i:0;s:5:"1.0.0";}i:2;a:3:{i:0;s:5:"Phine";i:1;s:10:"Phine\Test";i:2;s:20:"Phine\Test\Exception";}}} |