Skip to content

Commit 828c8ea

Browse files
technicalgurutechnicalguru
committed
Releasing 1.0.0
2 parents e76e2fb + 76abc4d commit 828c8ea

18 files changed

+1809
-1
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ composer.phar
44
# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
55
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
66
# composer.lock
7+
/composer.lock

‎.project

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>php-utils</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
</buildSpec>
9+
<natures>
10+
</natures>
11+
</projectDescription>

‎LICENSE.md

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

Lines changed: 189 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,190 @@
11
# php-utils
2-
Basic Classes for PHP
2+
This is a collection of useful classes and functions for every day PHP life. It includes things such as:
3+
4+
* Handling dates and times and various appearances of it
5+
* Searching and sorting of arrays of objects
6+
* Logging to error_log with different levels
7+
* Notification to users across various requests within a session
8+
* Extracting information from the current HTTP request
9+
* Generating random strings
10+
11+
These classes are no rocket science, just simple helpers that prevent from wiriting the
12+
same code in various flavours over and over again.
13+
14+
# License
15+
This project is licensed under [GNU LGPL 3.0](LICENSE.md).
16+
17+
# Installation
18+
19+
## By Composer
20+
21+
```
22+
composer install technicalguru/utils
23+
```
24+
25+
## By Package Download
26+
You can download the source code packages from [GitHub Release Page](https://github.com/technicalguru/php-utils/releases)
27+
28+
# Classes
29+
30+
## Request class
31+
The Request class extracts many useful information from the current HTTP request. It provides:
32+
33+
* Header information
34+
* GET and POST parameter values, assigning defaults if not present
35+
* Getting the method, protocol, host and path information from the HTTP request
36+
* Checking the elapsed time of this request
37+
38+
It is possible to create an object yourself, but it is recommend to use the singleton:
39+
40+
```
41+
$request = \TgUtils\Request::getRequest();
42+
```
43+
44+
Inspect the [source code](https://github.com/technicalguru/php-utils/blob/src/TgUtils/Request.php) to find out about the various methods available.
45+
46+
## Date class
47+
48+
The date class handles issues for localization, timezones and conversion into different formats or creation from various formats. Here are some examples:
49+
50+
```
51+
use TgUtils\Date;
52+
53+
$timezone = 'Europe/Berlin';
54+
55+
// Creating instances with local timezone
56+
$date = new Date(time(), $timezone);
57+
$date = Date::createLocalInstance(time(), $timezone);
58+
$date = Date::createFromMysql($mySqlTimestampString, $timezone);
59+
60+
// The Epoch time in seconds
61+
$unixTimestamp = $date->toUnix();
62+
63+
// Converting and formatting with local timezone
64+
$mysqlTimstamp = $date->toMysql(TRUE);
65+
$iso8601 = $date->toISO8601(TRUE);
66+
$someString = $date->format('d.m.Y H:i:s', TRUE);
67+
68+
// Converting to UTC timezones instances
69+
$mysqlTimstamp = $date->toMysql();
70+
$iso8601 = $date->toISO8601();
71+
$someString = $date->format('d.m.Y H:i:s');
72+
```
73+
74+
Inspect the [source code](https://github.com/technicalguru/php-utils/blob/src/TgUtils/Date.php) to find out about the various methods available.
75+
76+
## Logging
77+
78+
Logging is very simple. Set your log level (if not INFO) and start logging:
79+
80+
```
81+
use TgLog\Log;
82+
83+
// Set the log level
84+
Log::setLogLevel(Log::ERROR);
85+
86+
// Simple line
87+
Log::error('A simple error message');
88+
89+
// This message will not go into the log
90+
Log::info('This message is lost.');
91+
92+
// Log an exception
93+
Log::error('An expception was caught: ', $exception);
94+
95+
// Log an object for later debugging
96+
Log::error('We have some problem here:', $object);
97+
```
98+
99+
The Log can also help when you need to debug something:
100+
101+
```
102+
use TgLog\Log;
103+
104+
// Get the stacktrace
105+
$stacktrace = Log::getStackTrace(__FILE__);
106+
107+
// Or log it with INFO level
108+
Log::infoStackTrace(__FILE__);
109+
```
110+
111+
The `__FILE__` parameter will oppress the current file from appearing in the stacktrace. You
112+
can easily use the function without this argument to have the current file included:
113+
114+
```
115+
$stacktrace = Log::getStackTrace();
116+
Log::infoStackTrace();
117+
```
118+
119+
## User Notifications
120+
121+
Sometimes it is hard to display success or error messages because the message needs to
122+
be displayed in another script, another HTTP call or even just later. The following snippet
123+
will remember the message across multiple call within a session.
124+
125+
```
126+
use TgLog\Log;
127+
use TgLog\Success;
128+
129+
Log::register(new Success('Your data was saved successfully.));
130+
```
131+
132+
The registartion will not only remember the message but also print the message into
133+
the error log when it's an instance of `Debug`, `Error`, `Warning` or `Info`.
134+
135+
In another call or script you can retrieve your messages again to display:
136+
137+
```
138+
use TgLog\Log;
139+
use TgLog\Success;
140+
141+
foreach (Log::get() AS $message) {
142+
switch ($message->getType()) {
143+
case 'success':
144+
echo '<div class="text-success">'.$message->getMessage().'</div>';
145+
break;
146+
case 'error':
147+
echo '<div class="text-danger">'.$message->getMessage().'</div>';
148+
break;
149+
}
150+
}
151+
152+
// Finally, clean all messages
153+
Log::clean();
154+
```
155+
156+
## Other Utils
157+
There are some daily tasks that need to be done in applications. The `Utils` class addresses a few of them:
158+
159+
```
160+
use TgUtils\Utils;
161+
162+
// create a random string
163+
$myId = Utils::generateRandomString(20);
164+
165+
// Find an object with UID 1
166+
$myObject = Utils::findByUid($objectList, 3);
167+
168+
// Find an object with a certain name
169+
$myObject = Utils::findBy($objectList, 'name', 'John');
170+
171+
// Sort an array of objects by its names
172+
Utils::sort($objectList, 'name');
173+
174+
// Sort an array of objects in reverse order of names
175+
Utils::sort($objectList, 'name', TRUE);
176+
177+
// Sort an array of objects in reverse order of names, ignore upper/lower case
178+
Utils::sort($objectList, 'name', TRUE, TRUE);
179+
180+
// Get all names from the list of objects
181+
$allNames = Utils::extractAttributeFromList($objectList, 'name');
182+
183+
// Mask a sensitive string
184+
$masked = Utils::anonymize($aPhoneNumber);
185+
```
186+
187+
Inspect the [source code](https://github.com/technicalguru/php-utils/blob/src/TgUtils/Utils.php) to find more about the methods available.
188+
189+
# Contribution
190+
Report a bug, request an enhancement or pull request at the [GitHub Issue Tracker](https://github.com/technicalguru/php-utils/issues).

0 commit comments

Comments
 (0)