{"id":18566938,"url":"https://github.com/wakerscz/cms-base-module","last_synced_at":"2025-05-15T20:08:42.084Z","repository":{"id":62546066,"uuid":"160614744","full_name":"wakerscz/cms-base-module","owner":"wakerscz","description":"⚒ Základní modul celého CMS. Poskytuje rozhraní pro usnadění vývoje dalších modulů a komponent. Dynamicky spojuje celou aplikaci.","archived":false,"fork":false,"pushed_at":"2020-08-01T00:30:03.000Z","size":80,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T13:28:33.326Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wakerscz.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-06T03:41:14.000Z","updated_at":"2020-08-01T00:26:42.000Z","dependencies_parsed_at":"2022-11-02T22:15:27.908Z","dependency_job_id":null,"html_url":"https://github.com/wakerscz/cms-base-module","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakerscz%2Fcms-base-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakerscz%2Fcms-base-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakerscz%2Fcms-base-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakerscz%2Fcms-base-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wakerscz","download_url":"https://codeload.github.com/wakerscz/cms-base-module/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254414501,"owners_count":22067272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T22:24:51.663Z","updated_at":"2025-05-15T20:08:37.068Z","avatar_url":"https://github.com/wakerscz.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BaseModule\nZákladní modul celé aplikace, obsahuje společné třídy, komponenty, assety, atp. Spojuje celou aplikaci.\n\n**Namespace:** `Wakers\\BaseModule\\\u003cfolder\u003e\\*`.\n\n**Vzorová třída:** `Wakers\\BaseModule\\Component\\Admin\\BreadCrumb\\BreadCrumb`\n\n\n## Komponenty\n\n### Admin (site-manager)\n1. `Admin\\BaseControl` - Předek všech Admin komponent - napříč celou aplikací (všechny Admin komponenty od něj dědí).\n2. `Admin\\NavBar` - generuje navigační (dropdown) menu v site-manageru.\n3. `Admin\\Bradcrumb` - generuje drobečkové menu v site-manageru.\n\n### Common (společné Admin i Frontend)\n1. `Common\\BaseControl` - Předek všech Common komponent - napříč celou aplikací (všechny Common komponenty od něj dědí).\n2. `Common\\AssetLoader` - zajištuje načítání JS, CSS, Fontů a dalších statických souborů.\n3. `Common\\Logout (HandleLogout)` - zajištuje odhlašování uživatelů.\n4. `Common\\Modal (HandleModalToggle)` - zajištuje otevírání modálních oken skrze PHP.\n5. `Common\\Notification` - zajištuje výpis notifikací skrze PHP.\n6. `Common\\PermissionWatcher` - porovnává identitu přihlášeného uživatele (zda-li nebyla změněna v DB).\n\n### Frontend\n1. `Frontend\\BaseControl` - Předek všech Frontend komponent - napříč celou aplikací (všechny Frontend komponenty od něj dědí).\n2. `Frontend\\DashboardModal` - modální okno s Dashboardem (sestaví podle použitých modulů - dle app.neon `parameters.dashboard`).\n\n## Buildery\n\n### ACL Builder\n1. `Builder\\AclBuilderFactory` - registuje celý ACL do DI podle použitých modulů.\n2. `Builder\\AuthorizatorBuilder` - předek všech Authorizátorů (osatatní od něj musí dědit).\n\nKaždý modulový Authorizator se musí registrovat v config.neon v sekci `parameters.acl`.\n\n## Presenter a layout\nPro všechny modulové AdminPresentry - napříč celou aplikací existuje předek `Presenter\\BaseAdminPresenter`.\n\n2. `Presenter\\BaseAdminPresenter` načítá výchozí layout: `@layout.latte`, v modulech lze tedy používat pouze view. \n3. `Presenter\\AdminPresenter` - Admin presenter pro base-module (lze zde registrovat komponenty pro base-module).\n\n## Util\n\n### Ajaxová validace formulářů\n`Util\\AjaxValidate` - traita s metodou `success`, kterou lze využít při validaci formulářu.\n\n1. Př: `$form-\u003eonValidate[] = function (Form $form) { $this-\u003evalidate($form) };`.\n\n\n### Práce se soubory\nPro práci se soubory slouží třída `Wakers\\BaseModule\\Util\\ProtectedFile`.\n\n1. Ukládá soubory do neveřejného adresáře.\n2. Pomocí 2 základních metod či maker lze soubory zpřístupnit.\n3. Zajištuje i generování náhledových obrázků (ořezů).\n\n#### Nahrávání souboru\n1. Z formuláře přijde objekt typu `Nette\\Http\\FileUpload $fileUpload`.\n2. Vytvoříme instanci `ProtectedFile $protectedFile` a uložíme soubor.\n\n```PHP\n$protectedFile = new ProtectedFile('my-super/sub-folder/', NULL);\n$tmsName = $protectedFile-\u003emove($fileUpload); // vrací unikátní název\n\n// ... Název někam uložíme - třeba do DB\n```\n\n##### Odstranění souborů\n1. Načteme název souboru.\n2. Vytvoříme instanci `ProtectedFile $protectedFile`, **již s názvem souboru**.\n3. Následně soubor odstraníme (z neveřejného i veřejného adresáře).\n\n```PHP\n$name = 'nahled.jpg' // Načteno např. z DB\n$protectedFile = new ProtectedFile('my-super/sub-folder/', $name);\n$protectedFile-\u003eremove();\n```\n\n\n#### Publikování souboru / vytvoření ořezu\nPublikování souboru či obrázku se může řešit na úrovni šablony viz latte šablona.\n\n1. Načteme název souboru.\n2. Vytvoříme instanci `ProtectedFile $protectedFile` **s názvem souboru** a přidáme mu i extra atribut.\n3. Soubor vypíšeme v šabloně a vypíšeme i atribut.\n\n##### Příklad PHP (Repository):\n```PHP\n$name = 'nahled.jpg'; // Načteno např. z DB\n$title = 'Titulek obrázku'; // Načteno např. z DB\n\n$protectedFile = new ProtectedFile('my-super/sub-folder/', $name);\n$protectedFile-\u003esetAttr('title', $title);\n```\n\n##### Příklad Latte:\n```LATTE\n\n{* Makro file vytvoří kopii souboru do veřejného adresáře a vrátí cestu k souboru *}\n\n\u003ca href=\"{file $protectedFile}\"\u003eOdkaz na soubor\u003c/a\u003e\n\n{* nebo *}\n\n\u003ca href=\"{$basePath . $protectedFile-\u003egetFile()}\"\u003eOdkaz na soubor\u003c/a\u003e\n\n\n{* Makro img vytvoří oříznutý obrázek a vrátí cestu k souboru\n   Pokud soubor ještě nebyl nahrán (neexistuje privátní soubor), vytvoří šedý obrázek *}\n\n\u003cimg src=\"{img $protectedFile, '1200xNULL', 'SHRINK_ONLY'}\" title=\"{$protctedFile-\u003egetAttr('title')}\"\u003e\n\n{* nebo *}\n\n\u003cimg src=\"{$basePath . $protectedFile-\u003egetPublicImage('1200xNULL', 'SHRINK_ONLY')}\" title=\"{$protectedFile-\u003egetAttr('title')}\"\u003e\n\n\n{* Vypíše pouze, pokud existuje privátní soubor - nevytváří tedy šedý obrázek *}\n\n{if $protectedFile-\u003egetPrivateFile()})\n    \u003cimg src=\"{img $protectedFile, '1200xNULL', 'SHRINK_ONLY'}\" title=\"{$protctedFile-\u003egetAttr('title')}\"\u003e\n{/if}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwakerscz%2Fcms-base-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwakerscz%2Fcms-base-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwakerscz%2Fcms-base-module/lists"}