Classes
@@ -76,7 +76,7 @@
Overview
- Namespace
+ Namespace
Class
@@ -96,7 +96,7 @@
-
Slim
+
This class provides some general API methods
@@ -109,7 +109,7 @@
-Api
+api\Api
@@ -118,8 +118,7 @@
@@ -130,14 +129,14 @@
Abstract
+
Namespace: api
-
Package: Slim
Author:
- Josh Lockhart
+ stubbfel
Since:
- 1.0.0
-
Located at api/Api.php
+ 20.06.2013
+
Located at api/Api.php
@@ -155,17 +154,17 @@
#
- __construct( )
+ __construct( )
- Constructor
+ Default-Constructor
- Constructor
+ Default-Constructor
@@ -190,14 +189,18 @@
#
- __destruct( )
+ __destruct( )
+ Default-DeConstructor
+
@@ -219,14 +222,18 @@
#
- connect( )
+ connect( )
+ Method start a connection to the database
+
+ Method start a connection to the database
+
@@ -327,11 +334,11 @@
protected
- mixed
+ <T>:SqlManager
|
- $sqlManager
+ $sqlManager
|
|
@@ -339,10 +346,14 @@
+ Variable for the sql manager of the api
+
+ Variable for the sql manager of the api
+
|
diff --git a/doc/class-HelloApi.html b/doc/class-api.SpsApi.html
similarity index 78%
rename from doc/class-HelloApi.html
rename to doc/class-api.SpsApi.html
index 828abf1..a548592 100644
--- a/doc/class-HelloApi.html
+++ b/doc/class-api.SpsApi.html
@@ -4,10 +4,10 @@
- Class HelloApi | GeoApi
+ Class api\SpsApi | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
@@ -43,12 +47,8 @@
- Class HelloApi
+ Class SpsApi
- Description of HelloApi
+ This class provides some spezial SpsAPI methods
@@ -109,14 +109,14 @@
-
- Api
+ api\Api
-
-HelloApi
+api\SpsApi
@@ -132,12 +132,14 @@
@@ -155,17 +157,17 @@
#
- __construct( )
+ __construct( )
- Constructor
+ Default-Constructor
- Constructor
+ Default-Constructor
@@ -174,7 +176,7 @@
Overrides
-
+
|
@@ -190,14 +192,18 @@
|
-
+
public
-
+ array[num]
|
- #
- sendHelloQuery( )
+ #
+ sendSpsQuery( array $queryArgs = array() )
+ Method stert a sps-query
+
+ Method stert a sps-query
+ Parameters
+
+ - $queryArgs
+ array
$queryArgs
+
+ Returns
+
+ array[num]
[assoc]
+
@@ -242,10 +261,10 @@
@@ -334,10 +353,10 @@
diff --git a/doc/class-config.DBConfig.html b/doc/class-config.DBConfig.html
new file mode 100644
index 0000000..8ec94fa
--- /dev/null
+++ b/doc/class-config.DBConfig.html
@@ -0,0 +1,258 @@
+
+
+
+
+
+
+ Class config\DBConfig | GeoApi
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class DBConfig
+
+
+
+
+ This clas is an container for the DBConf
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties summary
+
+
+ public static
+ string
+ |
+
+
+ $sqlServer
+ |
+ "localhost" |
+
+ #
+
+
+
+ Address of the sqlserver
+
+
+
+
+
+ Address of the sqlserver
+
+
+
+ |
+
+
+
+ public static
+ string
+ |
+
+
+ $sqlDBName
+ |
+ "geoDB" |
+
+ #
+
+
+
+ name of the database
+
+
+
+
+
+ name of the database
+
+
+
+ |
+
+
+
+ public static
+ string
+ |
+
+
+ $sqlDBUser
+ |
+ "geoDB" |
+
+ #
+
+
+
+ user of the database
+
+
+
+
+
+ user of the database
+
+
+
+ |
+
+
+
+ public static
+ string
+ |
+
+
+ $sqlDBUserPW
+ |
+ "VZrSAYvmcrntQ97b" |
+
+ #
+
+
+
+ password of the database
+
+
+
+
+
+ password of the database
+
+
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/class-HelloApiSQLManager.html b/doc/class-database.SpsSqlManager.html
similarity index 60%
rename from doc/class-HelloApiSQLManager.html
rename to doc/class-database.SpsSqlManager.html
index 27bc873..45e281a 100644
--- a/doc/class-HelloApiSQLManager.html
+++ b/doc/class-database.SpsSqlManager.html
@@ -4,10 +4,10 @@
- Class HelloApiSQLManager | GeoApi
+ Class database\SpsSqlManager | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
@@ -43,12 +47,8 @@
- Class HelloApiSQLManager
+ Class SpsSqlManager
- The SQLManager manage the SQL-Connection for an API
+ Description of SpsSqlManager
-
- SQLManager
-
+database\SQLManager
-
-HelloApiSQLManager
+database\SpsSqlManager
@@ -125,12 +124,14 @@
@@ -148,22 +149,24 @@
|
@@ -179,48 +182,63 @@
|
|
-
+
public
-
+ array
|
- #
- sendHelloQuery( )
+ #
+ sendSpsQuery( array $queryArgs = array() )
+ Methods send an query for the sps-service
+
+ Methods send an query for the sps-service
+ Parameters
+
+ - $queryArgs
+ array
$queryArgs
+
+ Returns
+
+ array
[num][assoc]
+
@@ -230,16 +248,6 @@
|
-
diff --git a/doc/class-SQLManager.html b/doc/class-database.SqlManager.html
similarity index 61%
rename from doc/class-SQLManager.html
rename to doc/class-database.SqlManager.html
index 17c3668..d5769fe 100644
--- a/doc/class-SQLManager.html
+++ b/doc/class-database.SqlManager.html
@@ -4,10 +4,10 @@
- Class SQLManager | GeoApi
+ Class database\SqlManager | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
@@ -43,12 +47,8 @@
- Class SQLManager
+ Class SqlManager
@@ -102,10 +102,6 @@
-
@@ -113,14 +109,16 @@
@@ -138,14 +136,18 @@
#
- __construct( )
+ __construct( )
+ Default-Constructor
+
@@ -167,14 +169,18 @@
#
- __destruct( )
+ __destruct( )
+ Default-DEConstructor
+
@@ -196,14 +202,18 @@
#
- connect( )
+ connect( )
+ Method setup the connection to the Database
+
+ Method setup the connection to the Database
+
@@ -214,7 +224,7 @@
|
-
+
public
@@ -224,15 +234,19 @@
|
- #
- close( )
+ #
+ closeConnection( )
+ Method close the connection
+
+ Method close the connection
+
@@ -247,24 +261,37 @@
protected
-
+ result[num][assoc]
|
#
- query( mixed $query )
+ query( string $query )
+ Method send a query to the Datebase and return the result
+
+ Method send a query to the Datebase and return the result
+ Parameters
+
+ - $query
+ string
$query
+
+ Returns
+
+ result[num][assoc]
+
diff --git a/doc/elementlist.js b/doc/elementlist.js
index 1759822..b989bf0 100644
--- a/doc/elementlist.js
+++ b/doc/elementlist.js
@@ -1,3 +1,3 @@
var ApiGen = ApiGen || {};
-ApiGen.elements = [["c","Api"],["c","ArrayAccess"],["c","ArrayIterator"],["c","Countable"],["c","ErrorException"],["c","Exception"],["c","HelloApi"],["c","HelloApiSQLManager"],["c","InvalidArgumentException"],["c","Iterator"],["c","IteratorAggregate"],["c","LogicException"],["c","RuntimeException"],["c","SeekableIterator"],["c","Serializable"],["c","SimpleXMLElement"],["c","Slim\\Environment"],["c","Slim\\Exception\\Pass"],["c","Slim\\Exception\\Stop"],["c","Slim\\Http\\Headers"],["c","Slim\\Http\\Request"],["c","Slim\\Http\\Response"],["c","Slim\\Http\\Util"],["c","Slim\\Log"],["c","Slim\\LogWriter"],["c","Slim\\Middleware"],["c","Slim\\Middleware\\ContentTypes"],["c","Slim\\Middleware\\Flash"],["c","Slim\\Middleware\\MethodOverride"],["c","Slim\\Middleware\\PrettyExceptions"],["c","Slim\\Middleware\\SessionCookie"],["c","Slim\\Route"],["c","Slim\\Router"],["c","Slim\\Slim"],["c","Slim\\View"],["c","SpsApi"],["c","SpsSqlManager"],["c","SQLManager"],["c","Traversable"]];
+ApiGen.elements = [["c","api\\Api"],["c","api\\SpsApi"],["c","ArrayAccess"],["c","ArrayIterator"],["c","config\\DBConfig"],["c","Countable"],["c","database\\SpsSqlManager"],["c","database\\SqlManager"],["c","ErrorException"],["c","Exception"],["c","InvalidArgumentException"],["c","Iterator"],["c","IteratorAggregate"],["c","LogicException"],["c","RuntimeException"],["c","SeekableIterator"],["c","Serializable"],["c","SimpleXMLElement"],["c","Slim\\Environment"],["c","Slim\\Exception\\Pass"],["c","Slim\\Exception\\Stop"],["c","Slim\\Http\\Headers"],["c","Slim\\Http\\Request"],["c","Slim\\Http\\Response"],["c","Slim\\Http\\Util"],["c","Slim\\Log"],["c","Slim\\LogWriter"],["c","Slim\\Middleware"],["c","Slim\\Middleware\\ContentTypes"],["c","Slim\\Middleware\\Flash"],["c","Slim\\Middleware\\MethodOverride"],["c","Slim\\Middleware\\PrettyExceptions"],["c","Slim\\Middleware\\SessionCookie"],["c","Slim\\Route"],["c","Slim\\Router"],["c","Slim\\Slim"],["c","Slim\\View"],["c","Traversable"]];
diff --git a/doc/index.html b/doc/index.html
index 64fd73a..69e2b67 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -20,7 +20,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
@@ -42,10 +46,12 @@
Classes
Interfaces
@@ -133,7 +136,13 @@
Namespaces summary
- | None |
+ api |
+
+
+ | config |
+
+
+ | database |
| PHP |
diff --git a/doc/namespace-PHP.html b/doc/namespace-PHP.html
index f8acea4..f6e138e 100644
--- a/doc/namespace-PHP.html
+++ b/doc/namespace-PHP.html
@@ -7,7 +7,7 @@
Namespace PHP | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
diff --git a/doc/namespace-Slim.Exception.html b/doc/namespace-Slim.Exception.html
index 8c82cd2..efa4562 100644
--- a/doc/namespace-Slim.Exception.html
+++ b/doc/namespace-Slim.Exception.html
@@ -7,7 +7,7 @@
Namespace Slim\Exception | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
diff --git a/doc/namespace-Slim.Http.html b/doc/namespace-Slim.Http.html
index 31c2f0f..0d85c59 100644
--- a/doc/namespace-Slim.Http.html
+++ b/doc/namespace-Slim.Http.html
@@ -7,7 +7,7 @@
Namespace Slim\Http | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
diff --git a/doc/namespace-Slim.Middleware.html b/doc/namespace-Slim.Middleware.html
index 8a7dbda..58d328f 100644
--- a/doc/namespace-Slim.Middleware.html
+++ b/doc/namespace-Slim.Middleware.html
@@ -7,7 +7,7 @@
Namespace Slim\Middleware | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
diff --git a/doc/namespace-Slim.html b/doc/namespace-Slim.html
index 4fb2cb3..e634c1b 100644
--- a/doc/namespace-Slim.html
+++ b/doc/namespace-Slim.html
@@ -7,7 +7,7 @@
Namespace Slim | GeoApi
-
+
@@ -21,7 +21,11 @@
Namespaces
- - None
+
- api
+
+ - config
+
+ - database
- PHP
diff --git a/doc/class-SpsSqlManager.html b/doc/namespace-api.html
similarity index 63%
rename from doc/class-SpsSqlManager.html
rename to doc/namespace-api.html
index 2d67b31..83c011f 100644
--- a/doc/class-SpsSqlManager.html
+++ b/doc/namespace-api.html
@@ -4,10 +4,10 @@
- Class SpsSqlManager | GeoApi
+ Namespace api | GeoApi
-
+
@@ -21,7 +21,11 @@
| | | | | | |