PHPackages rkw/rkw-competition - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. rkw/rkw-competition ActiveTypo3-cms-extension[Utility & Helpers](/categories/utility) rkw/rkw-competition =================== Register handling for "RKW Competition" v10.4.2-stable(2mo ago)06↓90%GPL-2.0+PHP Since Mar 23Pushed 2mo ago1 watchersCompare [ Source](https://github.com/RKWKomZe/RkwCompetition)[ Packagist](https://packagist.org/packages/rkw/rkw-competition)[ RSS](/packages/rkw-rkw-competition/feed)WikiDiscussions master Synced 3w ago READMEChangelogDependencies (4)Versions (5)Used By (0) RkwCompetition ============== [](#rkwcompetition) - HowTo: To install your own "OwnCloud" server take a look to the section "Development" below 1. Extension usage for integrators ---------------------------------- [](#1-extension-usage-for-integrators) 1. Add RkwCompetition TypoScript template to your page 2. If it hasn't happened yet, install hCaptcha: - `ddev composer require dreistromland/typo3-hcaptcha` - Add hCaptcha TypoScript template to your page 3. Create or use an existing page of type "folder" in your TYPO3 Backend 4. Create the folder path /fileadmin/user\_upload/tx\_rkwcompetition/ (if not exists) 5. Set up your local TypoScript like the following example: ``` plugin.tx_rkwcompetition { persistence { # The competition basic folder storagePid = 11923 } settings { # The general webPage loginPid loginPid = 10513 # The page where you've placed your competition plugin competitionPid = 2547 # The register PID (could be a subpage of the competitionPid) registerPid = 11924 # Jury register PID juryPid = 11928 mandatoryFields { # set mandatory fields for the register form register = firstName, lastName # additional mandatory fields which only trigger if groupWork is selected registerGroupWork = groupWorkAuthorization, groupWorkAddPersons } api { ownCloud { baseUrl = http://ddev-RKW-Website-owncloud:8080/ admin { username = admin password = admin } } } } } ``` ### 1.1 Create basic records inside a folder of your choice [](#11-create-basic-records-inside-a-folder-of-your-choice) 1. Create a ***FrontendUserGroup*** for FrontendUser ***participants*** 2. Create a ***FrontendUserGroup*** for FrontendUser ***jury members*** 3. You will need at least ***one FrontendUser*** for usage as a ***jury member*** to create a competition 4. Create "Sector" records ("Bereich") ***before*** creating a competition 5. Create your first "Competition" record ("Wettbewerb") ### 1.2 Frontend Part One: Competition & Register Plugins [](#12-frontend-part-one-competition--register-plugins) 1. Insert the plugin to show the competitions themselves on your chosen page (`settings.competitionPid`) 1. Plugin Name: "RKW Competition: Wettbewerb \[rkwcompetition\_competition\]" 2. Select a competition record inside the FlexForm of the plugin 2. Insert the register plugin to the other created page (`settings.registerPid`) 1. Plugin Name: "RKW Competition: Anmeldung \[rkwcompetition\_register\]" ### 1.3 Frontend Part Two: Plugins for Participants & Jury-Member (Login Area) [](#13-frontend-part-two-plugins-for-participants--jury-member-login-area) 1. Create new page "Mein Wettbewerb" 1. Plugin Name: "RKW Competition: Teilnehmer (Login-Bereich)" 2. Set the page access rights for specific FrontendUserGroup of ***participants*** 2. Create new page "Meine Jurytätigkeit" 1. Plugin Name: "RKW Competition: Jury (Login-Bereich)" 2. Set the page access rights for specific FrontendUserGroup of ***jury members*** --- 2. The Jury ----------- [](#2-the-jury) Jury members are basically normal FrontendUsers with a certain FrontendUserGroup. They can be added to a ***Competition*** as a ***candidate*** ("jury\_member\_candidate"). They do not belong to any particular FrontendUserGroup at this time. Through a cronjob ("JuryNotifyCommand"), they will get emails with deadline information and an invitation to accept the membership. If a FrontendUser and candidate accepts the membership, the FrontendUser gets the defined FrontendUserGroup for jury members and will be added as a ***confirmed jury member*** to the ***competition***. ***@toDo: Do we need a function for admins to notify them if a jury member does not accept the invitation?*** --- 3. Explore the Backend Module ----------------------------- [](#3-explore-the-backend-module) The backend module is used by BackendUsers (also called "Admins") to take a first look at the documents of the registrations. The admins have the ***task*** of ***accepting*** registrations in the first instance or ***refusing*** them with reasons. This is an important part of the extension's functionality. Hint for initial usage: It is advisable to have ***at least one registration created*** before the backend module is accessed for ***test purposes***. 1. Click on "RKW Competition" inside the "Web" area 2. A list of ***competitions*** shows up as a table. Select one by using the "show" link on the right 3. This leads to a list of ***registrations***. You can view them by using the "show" link 4. Now an admin can get a ***detailed overview*** of the registration including a ***file download*** 5. The admin can determine whether to ***accept*** or to ***refuse*** the registration --- 4. Cronjobs ----------- [](#4-cronjobs) This extension comes with a bunch of cronjobs which manage the several steps from initial registration until the assignment to the jury member: - rkw\_competition:incompleteUserRegistration - Sends notification emails to FrontendUsers if they have not submitted their registration yet - Options: - `--rootPageUid` (int): The root page UID to use for loading TypoScript settings (optional, default: 1) - `--timeInterval` (int): Defines the length of one interval to send e-mails as reminder for the user to complete and submit their registration (optional, default: 86400) - rkw\_competition:removalDeadlineWarningAdmin - Only if a data removal date is set: Send a reminder to admins before an expired competition is about to be deleted together with the documents - rkw\_competition:juryNotify - Sends notification emails to jury members when a registration period ends (and their work starts) - Sends also reminder messages to jury members who have not accepted the jury member terms yet - rkw\_competition:closingDay - Triggers on the closing day of the registration period of a competition - Sends emails to admins with a reference to the possibility of downloading all submitted documents in the backend - Info (success; accepted for participation) email to participants with complete and verified data - Info (failed; excluded from competition) email to participants with incomplete or incorrect data - rkw\_competition:cleanup - Removes competitions with their registration records (+ uploaded files) from HD --- 5. Workflow =========== [](#5-workflow) A step-by-step journey with all components through the RkwCompetition after all configuration steps are done (steps 1-4). HINT: If the tester has to do something manually that should be done automatically ("cronjobs"), this is displayed below as ***TASK***. If the system does something on its own, this will be displayed as ***TRIGGER***. 5.1 Initial registration procedure (as a FrontendUser) ------------------------------------------------------ [](#51-initial-registration-procedure-as-a-frontenduser) 1. Go to the competition page (Plugin: rkwcompetition\_competition; CompetitionController->showAction) 2. Click the link to the registration page (Plugin: rkwcompetition\_register; RegisterController->newAction) 3. Fill out the form including all mandatory fields and send it (RegisterController->createAction) 1. ***TASK:*** Kick off cronjob "postmaster:send" manually 2. ***TRIGGER:*** Opt-In email is sent to the registered email address (RkwMailService->optInRequest) 4. Go to your email program and open the email. Choose one of the two links: 1. Decline: The registration will be removed (RegisterController->optInAction) 2. Accept: The registration will be executed (RegisterController->optInAction) 1. ***TASK:*** Kick off cronjob "postmaster:send" manually 2. ***TRIGGER:*** Confirmation email is sent to FrontendUser (RkwMailService->confirmRegisterUser) 3. ***TRIGGER:*** Notification email is sent to FrontendUser ("Upload") (RkwMailService->uploadDocumentsUser) 4. ***TRIGGER:*** Notification email to admin ("New competition registration") (RkwMailService->confirmRegisterAdmin) 5. ***TRIGGER:*** OwnCloud folder created; access links persisted (Register-Model; Competition-Model) 5.2 Uploads and final submit (as a FrontendUser) ------------------------------------------------ [](#52-uploads-and-final-submit-as-a-frontenduser) 1. Login to "Mein RKW" with the email address of the completed registration (@see 5.1) 2. Go to the subarea "Mein Wettbewerb" (@see 1.3). You should see at least the competition you have registered for (ParticipantController->listAction) 3. Click on the button for file uploads ("Dateien hochladen") (UploadController->editAction) 4. Now upload at least the abstract ("Kurzfassung") as a Word or PDF file 1. Any other format (.jpg etc.) should throw an error 5. Go back to "Mein Wettbewerb" (@see 1.3) and click the button on the right ("Submit"; "Einreichen") 6. A page shows up with a last checklist and hints for the user before committing (RegisterController->submitQuestionAction) 7. Select the checkbox and submit (RegisterController->submitAction) 1. ***TRIGGER:*** Status of registration is changed to "submitted" (Field: userSubmittedAt) 2. ***TASK:*** Kick off cronjob "postmaster:send" manually 3. ***TRIGGER:*** Confirmation email is sent to FrontendUser (RkwMailService->submitRegisterUser) 4. ***TRIGGER:*** Notification email to admin ("Registration submitted") (RkwMailService->submitRegisterAdmin) 5.3 Admin preselection (as a BackendUser) ----------------------------------------- [](#53-admin-preselection-as-a-backenduser) 1. Click on "RKW Competition" inside the "Web" area (BackendController->listAction) 2. Select the desired competition and then the corresponding registration (BackendController->showAction) 3. Now you can take a look at the registration and choose between two options (BackendController->registerDetailAction) 1. Refuse: Something is wrong with the registration? Type in the reason for it and submit (BackendController->refuseAction) 1. ***TRIGGER:*** Status of registration is changed to "refused" (Field: adminRefusedAt) 2. ***TASK:*** Kick off cronjob "postmaster:send" manually 3. ***TRIGGER:*** Refusal email is sent to FrontendUser (RkwMailService->refusedRegisterUser) 4. The reason for refusal is shown to the user inside the email and in the list "Mein Wettbewerb" 5. Now the user can change things and submit the registration again 2. Accept: Everything looks good? Approve it! (BackendController->approveAction) 1. ***TRIGGER:*** Status of registration is changed to "approved" (Field: adminApprovedAt) 2. ***TASK:*** Kick off cronjob "postmaster:send" manually 3. ***TRIGGER:*** Success email is sent to FrontendUser (RkwMailService->approvedRegisterUser) 4. Now the FrontendUser is finished with the registration 5.4 Become a jury member ------------------------ [](#54-become-a-jury-member) 1. GIVEN: The competition date is between "RegisterEnd" and "JuryAccessEnd" 2. GIVEN: A FrontendUser is set as "Jury Member Candidate" for the competition 1. This means that the jury member is a candidate and not a full-fledged jury member 2. First of all, the jury candidate has to agree to the terms. If this has not happened yet, do it now: 1. ***TASK:*** Kick off cronjob "rkw\_competition:juryNotify" manually (RkwMailService->juryNotifyUser) 2. ***TASK:*** Kick off cronjob "postmaster:send" manually 3. ***TRIGGER:*** Notification email is sent to FrontendUser to confirm the role as a jury member 3. Login with your FrontendUser (the "jury candidate") to "Mein RKW" 4. Go to "Meine Jurytätigkeit" (@see 1.3) 5. Click the button to agree ("Einwilligen") 6. The FrontendUser is now a fully qualified jury member for this competition and can view the registrations Hint: To repeat the jury member process for testing purposes, you have to delete the "juryReference" record and reset the field "reminder\_jury\_mail\_tstamp" inside the competition record. Development ----------- [](#development) ### OwnCloud as part of your current DDEV project [](#owncloud-as-part-of-your-current-ddev-project) Add following as "docker-compose.owncloud.yml" to your .ddev folder: ``` version: "3" volumes: files: driver: local mysql: driver: local redis: driver: local services: owncloud: image: owncloud/server:10.15 container_name: ddev-${DDEV_SITENAME}-owncloud labels: com.ddev.site-name: ${DDEV_SITENAME} com.ddev.approot: ${DDEV_APPROOT} hostname: ddev-${DDEV_SITENAME}-owncloud restart: always depends_on: - mariadb - redis environment: - VIRTUAL_HOST=$DDEV_HOSTNAME - HTTP_EXPOSE=8985:8080 #- HTTPS_EXPOSE=8986:8985 - OWNCLOUD_DOMAIN=rkw-website.ddev.site:8080, ddev-RKW-Website-owncloud - OWNCLOUD_TRUSTED_DOMAINS=rkw-website.ddev.site, ddev-RKW-Website-owncloud, ddev-rkw-website-owncloud:8080 - OWNCLOUD_DB_TYPE=mysql - OWNCLOUD_DB_NAME=owncloud - OWNCLOUD_DB_USERNAME=owncloud - OWNCLOUD_DB_PASSWORD=owncloud - OWNCLOUD_DB_HOST=mariadb - OWNCLOUD_ADMIN_USERNAME=admin - OWNCLOUD_ADMIN_PASSWORD=admin - OWNCLOUD_MYSQL_UTF8MB4=true - OWNCLOUD_REDIS_ENABLED=true - OWNCLOUD_REDIS_HOST=redis healthcheck: test: ["CMD", "/usr/bin/healthcheck"] interval: 30s timeout: 10s retries: 5 volumes: - files:/mnt/data mariadb: image: mariadb:10.11 # minimum required ownCloud version is 10.9 container_name: ddev-${DDEV_SITENAME}-owncloud_mariadb restart: always environment: - MYSQL_ROOT_PASSWORD=owncloud - MYSQL_USER=owncloud - MYSQL_PASSWORD=owncloud - MYSQL_DATABASE=owncloud - MARIADB_AUTO_UPGRADE=1 command: ["--max-allowed-packet=128M", "--innodb-log-file-size=64M"] healthcheck: test: ["CMD", "mysqladmin", "ping", "-u", "root", "--password=owncloud"] interval: 10s timeout: 5s retries: 5 volumes: - mysql:/var/lib/mysql redis: image: redis:6 container_name: ddev-${DDEV_SITENAME}-owncloud_redis restart: always command: ["--databases", "1"] healthcheck: test: ["CMD", "redis-cli", "ping"] interval: 10s timeout: 5s retries: 5 volumes: - redis:/data ``` Restart ddev (if already running): ``` ddev restart ``` Get the browser URL of the "OwnCloud"-Service: ``` ddev describe ``` URL: OwnCloud login: ``` User: admin PW: admin ``` To work with the API inside the container we have to use the container name as URL (with different port!): ``` URL (with port): http://ddev-RKW-Website-owncloud:8080 ``` How it's created: [http://ddev-${DDEV\_SITENAME}-owncloud](http://ddev-$%7BDDEV_SITENAME%7D-owncloud) TypoScript basic setup: ``` api { owncloud { baseUrl = http://ddev-RKW-Website-owncloud:8080/ } } ``` Example API queries: ``` Browser: http://rkw-website.ddev.site:8985/ocs/v1.php/cloud/capabilities?format=json http://rkw-website.ddev.site:8985/ocs/v1.php/cloud/users?format=json API: http://ddev-RKW-Website-owncloud:8080/ocs/v1.php/cloud/capabilities?format=json http://ddev-RKW-Website-owncloud:8080/ocs/v1.php/cloud/users?format=json ``` You have to be logged in with credentials (admin / admin) before seeing any response from these example queries. Example API query with credentials and debug info (this query returns a user list of the given OwnCloud instance): ``` $credentials = [ 'admin', 'admin' ]; $url = 'http://ddev-RKW-Website-owncloud:8080/ocs/v1.php/cloud/users?format=json'; $ch = curl_init($url); curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic ' . base64_encode(implode(':', $credentials))]); curl_setopt($ch, CURLOPT_TIMEOUT, 5); curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = curl_exec($ch); $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_errno($ch)) { print curl_error($ch); } curl_close($ch); \TYPO3\CMS\Core\Utility\DebugUtility::var_dump($httpcode); var_dump($data); exit; ``` --- \########################################### ### DEPRECATED: Independent OwnCloud docker installation (NOT USED: API connection issues) [](#deprecated-independent-owncloud-docker-installation-not-used-api-connection-issues) **Local "OwnCloud" installation; add OwnCloud-Container** See: [https://doc.owncloud.com/server/next/admin\_manual/installation/docker/#docker-compose](https://doc.owncloud.com/server/next/admin_manual/installation/docker/#docker-compose)Config: [https://doc.owncloud.com/server/next/admin\_manual/configuration/server/config\_sample\_php\_parameters.html](https://doc.owncloud.com/server/next/admin_manual/configuration/server/config_sample_php_parameters.html) 1. Create new directory for owncloud docker ``` mkdir owncloud-docker-server cd owncloud-docker-server ``` 2. Copy the docker-compose.yml without any changes into the main directory: "/owncloud-docker-server/docker-compose.yml" 3. In case of any problems change the Port inside the .env file (which is also placed into the main directory): "/owncloud-docker-server/.env" **DO NOT USE :8080 in your .env file as HTTP\_PORT because it may already be in use** ``` OWNCLOUD_VERSION=10.15 OWNCLOUD_DOMAIN=owncloud.local:8080 OWNCLOUD_TRUSTED_DOMAINS=owncloud.local ADMIN_USERNAME=admin ADMIN_PASSWORD=admin HTTP_PORT=8000 ``` 4. Add to your /etc/hosts: ``` 127.0.0.1 owncloud.local ``` 5. Start it ``` docker compose up -d ``` 6. Use it (login with "admin" / "admin"; @see .env file) ``` http://owncloud.local:8000 (Alternativ: http://localhost:8000) ``` 7. If you are authorized, you can run custom API test in your browser ``` http://owncloud.local:8000/ocs/v1.php/cloud/capabilities?format=json http://localhost:8000/ocs/v1.php/cloud/capabilities?format=json ``` [https://doc.owncloud.com/server/next/developer\_manual/core/apis/ocs-capabilities.html](https://doc.owncloud.com/server/next/developer_manual/core/apis/ocs-capabilities.html)8. Do not use the port number for API-calls when using it from your local RKW-Machine ``` api { owncloud { baseUrl = http://owncloud.local/ } } ``` 9. Stop it ``` docker-compose down ``` Learn API stuff here: [https://doc.owncloud.com/server/next/developer\_manual/core/apis/provisioning-api.html#introduction](https://doc.owncloud.com/server/next/developer_manual/core/apis/provisioning-api.html#introduction) ### Health Score 35 — LowBetter than 77% of packages Maintenance86 Actively maintained with recent releases Popularity4 Limited adoption so far Community9 Small or concentrated contributor base Maturity37 Early-stage or recently created project Bus Factor1 Top contributor holds 67% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~11 days Total 3 Last Release 72d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/ca11ace9490b8fe0b145e7d32464fba5c8eddaa88d700b95d32241a226623e76?d=identicon)[SteffenKroggel](/maintainers/SteffenKroggel) --- Top Contributors [![addorange](https://avatars.githubusercontent.com/u/1980618?v=4)](https://github.com/addorange "addorange (65 commits)")[![MaxFaessler](https://avatars.githubusercontent.com/u/45080955?v=4)](https://github.com/MaxFaessler "MaxFaessler (32 commits)") ### Embed Badge ![Health badge](/badges/rkw-rkw-competition/health.svg) ``` [![Health](https://phpackages.com/badges/rkw-rkw-competition/health.svg)](https://phpackages.com/packages/rkw-rkw-competition) ``` ### Alternatives [friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 101466.4k45](/packages/friendsoftypo3-content-blocks)[wazum/sluggi TYPO3 extension for URL slug management with inline editing, auto-sync, locking, access control, and redirects 41515.2k](/packages/wazum-sluggi)[praetorius/vite-asset-collector Use AssetCollector to embed frontend assets generated by vite 54299.7k1](/packages/praetorius-vite-asset-collector)[typo3/cms-redirects TYPO3 CMS Redirects - Create manual redirects, list existing redirects and automatically createredirects on slug changes. 167.3M74](/packages/typo3-cms-redirects)[typo3/cms-sys-note TYPO3 CMS System Notes - Records with messages which can be placed on any page and contain instructions or other information related to a page or section. 116.2M37](/packages/typo3-cms-sys-note)[b13/assetcollector Asset collector - Add CSS and SVG files and strings as inline style tag/inline svg to the html code. 10123.2k](/packages/b13-assetcollector) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)