diff --git a/Kod%3A-%C5%81adowanie-g%C5%82%C3%B3wnego-pliku-konfiguracyjnego-%27config.cfg%27.md b/Kod%3A-%C5%81adowanie-g%C5%82%C3%B3wnego-pliku-konfiguracyjnego-%27config.cfg%27.md new file mode 100644 index 0000000..af2baaa --- /dev/null +++ b/Kod%3A-%C5%81adowanie-g%C5%82%C3%B3wnego-pliku-konfiguracyjnego-%27config.cfg%27.md @@ -0,0 +1,33 @@ +# Ładowanie głównego pliku konfiguracyjnego 'config.cfg' + +Klasa `CFG` odpowiedzialna jest za zarządzanie plikiem konfiguracyjnym 'config.cfg' + +### Odczytywanie pojedyńczej zmiennej z pliku (`R`) + +Funkcja ta, jest odpowiedzialna za odczytanie zawartości danego recordu i sprawdzenie jego poprawności + +1. Inicjacja funkcji `__checkIfFileExist` w celu sprawdzenia czy plik 'config.cfg' istnieje +2. Zczytanie i zapisanie wszystkich danych z pliku 'config.cfg' do słownika `content` w formacie: `'nazwa zmiennej' : ['zmienna', 'typ zmiennej']` +3. Inicjacja funckji `__checkIfRecordExist` w celu sprawdzenia czy w słowniku `content` znajduje się żądany record +4. Inicjacja, odpowiedniej dla typu zmiennej, funkcji mającej na celu sprawdzenie jej poprawności i jej przetworzenie +5. Funkcja zwraca wartość zmiennej. + +### Zapisywanie zmian w pliku (`W`) + +Funkcja ta jest odpowiedzialna za sprawdzenie, przetworzenie i zapisanie zmian w pliku konfiguracyjnych. + +1. Inicjacja funkcji `__checkIfFileExist` w celu sprawdzenia czy plik 'config.cfg' istnieje +2. Zczytanie i zapisanie wszystkich danych z pliku 'config.cfg' do słownika `content` w formacie: `'nazwa zmiennej' : ['zmienna', 'typ zmiennej']` +3. Inicjacja, odpowiedniej dla typu zmiennej, funkcji mającej na celu sprawdzenie jej poprawności i jej przetworzenie, dla każdego recordu ze słownika `changes` +4. Nadpisanie zmiennej ze słownika content, wartością `var`. +5. Zapisanie zawartości słownika `content` w pliku 'config.cfg' +6. Funkcja zwraca `True` jeżeli operacja została wykonana pomyślnie lub `False` jeżeli wystąpił błąd + +### Funkcje sprawdzające istnienie + +- `__checkIfFileExist` - funkcja sprawdza czy plik istnieje i możliwe jest jego nadpisanie (w przypadku zapisu) +- `__checkIfRecordExist` - funkcja sprawdza czy `record` istnieje w słowniku `content` + +### Funkcje sprawdzające poprawność recordu + +Funkcje te odpowiadają za sprawdzenie poprawności zmiennej i w razie potrzeby przetwarzają ją na pożądaną formę. \ No newline at end of file