Skip to content

Commit 12abbb9

Browse files
committed
Update README.md
1 parent fe54d07 commit 12abbb9

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,70 @@ $setting = new Config('****', [$dsn_path_user, $password, $database, $other_sett
4040
$db = new ez_****($settings);
4141
```
4242

43-
$db->query_prepared($query_string, $param_array);
43+
This library will assume the developer is using some sort of IDE with intellisense enabled. The comments/doc-block area will hold any missing documentations. For additional examples see __phpunit__ tests, The tests are fully functional integration tests, meaning the are live database tests, no mocks.
44+
45+
##### General Methods
46+
---
47+
to_string($arrays, $separation = ',');
48+
clean($string);
49+
create_cache(string $path = null);
50+
securePDO($vendor = null,
51+
$key = 'certificate.key',
52+
$cert = 'certificate.crt',
53+
$ca = 'cacert.pem',
54+
$path = '.'._DS
55+
);
56+
createCertificate(string $privatekeyFile = certificate.key,
57+
string $certificateFile = certificate.crt,
58+
string $signingFile = certificate.csr,
59+
string $ssl_path = null, array $details = [commonName => localhost]
60+
);
61+
62+
___Shortcut Table Methods___
63+
64+
create(string $table = null, ...$schemas);// $schemas requires... column()
65+
column(string $column = null, string $type = null, ...$args);
66+
drop(string $table);
67+
---
68+
69+
innerJoin(string $leftTable = null, string $rightTable = null,
70+
string $leftColumn = null, string $rightColumn = null, $condition = EQ);
71+
72+
leftJoin(string $leftTable = null, string $rightTable = null,
73+
string $leftColumn = null, string $rightColumn = null, $condition = EQ);
74+
75+
rightJoin(string $leftTable = null, string $rightTable = null,
76+
string $leftColumn = null, string $rightColumn = null, $condition = EQ);
77+
78+
fullJoin(string $leftTable = null, string $rightTable = null,
79+
string $leftColumn = null, string $rightColumn = null, $condition = EQ);
80+
---
81+
82+
```php
83+
prepareOn(); // When activated will use prepare statements for all shortcut SQL Methods calls.
84+
prepareOff(); // When off shortcut SQL Methods calls will use vendors escape routine instead. This is the default behavior.
85+
```
86+
87+
### Shortcut SQL Methods
88+
89+
* `having(...$having);`
90+
* `groupBy($groupBy);`
91+
* `union(string $table = null, $columnFields = '*', ...$conditions);`
92+
* `unionAll(string $table = null, $columnFields = '*', ...$conditions);`
93+
* `orderBy($orderBy, $order);`
94+
* `limit($numberOf, $offset = null)`
95+
* `where( ...$whereKeyArray);`
96+
* `selecting(string $table = null, $columnFields = '*', ...$conditions);`
97+
* `create_select(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere);`
98+
* `select_into(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere);`
99+
* `update(string $table = null, $keyAndValue, ...$whereKeys);`
100+
* `delete(string $table = null, ...$whereKeys);`
101+
* `replace(string $table = null, $keyAndValue);`
102+
* `insert(string $table = null, $keyAndValue);`
103+
* `insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere);`
104+
105+
---
106+
107+
query_prepared(string $query_string, array $param_array);
44108

45109
**For** **[Authors/Contributors](https://github.com/ezsql/ezsql/CONTRIBUTORS.md)**

0 commit comments

Comments
 (0)