From 0868e0642f694bf5c08951f67f5a4b7eadde041a Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Thu, 05 Sep 2013 21:22:22 +0000
Subject: [PATCH] Zmiana numeru wersji na 2.6, testy jednostkowe niektórych klas (PHPUnit), dodanych wiele komentarzy dotyczących metod oraz atrybutów (Doxygen), aktualizacja instrukcji instalacji i aktualizacji.

---
 class/BotUser.php |   21 +++++++++++++++++----
 1 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/class/BotUser.php b/class/BotUser.php
index c2b209a..2fe8251 100644
--- a/class/BotUser.php
+++ b/class/BotUser.php
@@ -9,13 +9,13 @@
 	 * - IMified
 	 * - HTTP
 	 * - Local
-	 * @var string
+	 * @var string $interface
 	 */
 	private $interface;
 	
 	/**
 	 * Numer lub identyfikator użytkownika
-	 * @var string
+	 * @var string $uid
 	 */
 	private $uid;
 	
@@ -29,22 +29,30 @@
 	 * - yahoo.imified.com
 	 * - gtalk.imified.com
 	 * - localhost
-	 * @var string
+	 * @var string $network
 	 */
 	private $network;
 	
 	/**
 	 * Identyfikator/unikalna nazwa bota, do którego skierowano zapytanie.
 	 * Najczęściej numer Gadu-Gadu lub botkey w przypadku IMified.com
+	 * @var string $bot
 	 */
 	private $bot;
 	
 	/**
 	 * Parametry zapytania. Przy IMified równe zmiennej $_POST['channel']
-	 * @var string
+	 * @var string $params
 	 */
 	private $params;
 	
+	/**
+	 * Konstruktor. W argumencie otrzymuje pseudo-URL określający użytkownika i sieć.
+	 * Przykłady:
+	 * - Gadu-Gadu://123456\@gadu-gadu.pl
+	 * - IMified://user\\\@jabber\@jabber.imified.com/BOTKEY?private
+	 * @param string $user URL użytkownika
+	 */
 	function __construct($user) {
 		$data = parse_url($user);
 		
@@ -55,6 +63,11 @@
 		$this->params = @$data['query'];
 	}
 	
+	/**
+	 * Umożliwia dostęp tylko do odczytu do prywanych zmiennych
+	 * @param string $name Nazwa zmiennej
+	 * @return mixed Wartość zmiennej prywatnej
+	 */
 	function __get($name) {
 		return $this->$name;
 	}

--
Gitblit v1.9.1