Skip to content
This repository has been archived by the owner on Feb 1, 2020. It is now read-only.

Commit

Permalink
Adding documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kherge committed Oct 15, 2013
1 parent d1ab818 commit a8bd955
Show file tree
Hide file tree
Showing 12 changed files with 338 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/1.0.0/1. Namespaces.md
@@ -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)
11 changes: 11 additions & 0 deletions docs/1.0.0/2. Classes.md
@@ -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.
6 changes: 6 additions & 0 deletions docs/1.0.0/3. Interfaces.md
@@ -0,0 +1,6 @@
Interfaces
==========

This is a complete list of available interfaces:

- There are no interfaces available.
1 change: 1 addition & 0 deletions docs/1.0.0/PROJECT_VERSION
@@ -0,0 +1 @@
1.0.0
33 changes: 33 additions & 0 deletions docs/1.0.0/Phine/Test/Exception/MethodException.md
@@ -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) &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of the method.
- _Returns:_ A new exception.
- [`PropertyException`](../../../Phine/Test/Exception/PropertyException.md)

33 changes: 33 additions & 0 deletions docs/1.0.0/Phine/Test/Exception/PropertyException.md
@@ -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) &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of the property.
- _Returns:_ A new exception.
- [`PropertyException`](../../../Phine/Test/Exception/PropertyException.md)

12 changes: 12 additions & 0 deletions docs/1.0.0/Phine/Test/Exception/TempException.md
@@ -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`.
64 changes: 64 additions & 0 deletions docs/1.0.0/Phine/Test/Method.md
@@ -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) &mdash; Finds a method for the given class.
- [`invoke()`](#invoke) &mdash; Invokes a method for the given class.
- [`invokeArgs()`](#invokeArgs) &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of the method.
- `$access` (`boolean`) &mdash; Make the method accessible?
- _Returns:_ The method.
- [`ReflectionMethod`](http://php.net/class.ReflectionMethod)
- It throws one of the following exceptions:
- `MethodException` &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of the method.
- `$args` (`array`) &mdash; A list of method arguments to pass.
- _Returns:_ The result of the invocation.
- `mixed`

63 changes: 63 additions & 0 deletions docs/1.0.0/Phine/Test/Property.md
@@ -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) &mdash; Finds a property for the given class.
- [`get()`](#get) &mdash; Returns the current value of a property.
- [`set()`](#set) &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of a property.
- `$access` (`boolean`) &mdash; Make the property accessible?
- _Returns:_ The property.
- [`ReflectionProperty`](http://php.net/class.ReflectionProperty)
- It throws one of the following exceptions:
- `PropertyException` &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; 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`) &mdash; The class instance or name.
- `$name` (`string`) &mdash; The name of a property.
- `$value` (`mixed`) &mdash; The new value.
- It does not return anything.

105 changes: 105 additions & 0 deletions docs/1.0.0/Phine/Test/Temp.md
@@ -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) &mdash; Sets the temporary directory path and path prefix.
- [`copyDir()`](#copyDir) &mdash; Copies an existing directory to a temporary path.
- [`copyFile()`](#copyFile) &mdash; Copies an existing file to a temporary path.
- [`createDir()`](#createDir) &mdash; Returns a new temporary directory path.
- [`createFile()`](#createFile) &mdash; Returns a new temporary file path.
- [`purgePaths()`](#purgePaths) &mdash; 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`) &mdash; The temporary directory path.
- `$prefix` (`string`) &mdash; 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`) &mdash; The directory to copy.
- `$prefix` (`string`) &mdash; 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`) &mdash; The file to copy.
- `$prefix` (`string`) &mdash; A path prefix.
- _Returns:_ The temporary file path.
- `string`
- It throws one of the following exceptions:
- [`Exception`](http://php.net/class.Exception)
- `TempException` &mdash; 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`) &mdash; A path prefix.
- _Returns:_ The temporary directory path.
- `string`
- It throws one of the following exceptions:
- [`Exception`](http://php.net/class.Exception)
- `TempException` &mdash; 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`) &mdash; A path prefix.
- _Returns:_ The temporary file path.
- `string`
- It throws one of the following exceptions:
- [`Exception`](http://php.net/class.Exception)
- `TempException` &mdash; 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`

1 change: 1 addition & 0 deletions docs/1.0.0/SAMI_VERSION
@@ -0,0 +1 @@
0.8.1-DEV
1 change: 1 addition & 0 deletions docs/1.0.0/renderer.index
@@ -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";}}}

0 comments on commit a8bd955

Please sign in to comment.