{"id":20961742,"url":"https://github.com/heimrichhannot/contao-filecredits","last_synced_at":"2025-05-14T07:30:59.216Z","repository":{"id":24419590,"uuid":"27820603","full_name":"heimrichhannot/contao-filecredits","owner":"heimrichhannot","description":"Contao module that adds credit support for images.","archived":true,"fork":false,"pushed_at":"2025-04-10T08:33:49.000Z","size":150,"stargazers_count":3,"open_issues_count":2,"forks_count":4,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-19T10:39:17.360Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heimrichhannot.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-10T13:16:31.000Z","updated_at":"2025-04-10T08:34:47.000Z","dependencies_parsed_at":"2022-08-06T02:00:10.605Z","dependency_job_id":null,"html_url":"https://github.com/heimrichhannot/contao-filecredits","commit_stats":null,"previous_names":[],"tags_count":66,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-filecredits","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-filecredits/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-filecredits/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-filecredits/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heimrichhannot","download_url":"https://codeload.github.com/heimrichhannot/contao-filecredits/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254094830,"owners_count":22013648,"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-19T02:16:21.811Z","updated_at":"2025-05-14T07:30:59.176Z","avatar_url":"https://github.com/heimrichhannot.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!CAUTION]\n\u003e **ABANDONED**\n\u003e \n\u003e This module has reached its end of life and will undergo no further development.\n\u003e\n\u003e Refer to the recommended replacement, which is also available for Contao 5 as of v2.\n\u003e\n\u003e [heimrichhannot/contao-filecredits-bundle](https://github.com/heimrichhannot/contao-filecredits-bundle)\n\n---\n\n# Filecredits\n\nContao module that adds credit support for images and files.\n\n## Installation\n\n```\ncomposer require heimrichhannot/contao-filecredits\n```\n\n### Disable command scheduler (poor-mans-cron) \n\nFor performance reasons, we insist on disabling the \"Command-Scheduler\" (enable `tl_settings.disableCron`) and run the cron jobs by a dedicated cronjob within your servers crontab.\n\n- Contao 4: `* * * * * wget -O /dev/null -q https://[DOMAIN-NAME]/_contao/cron --no-check-certificate`  \n- Contao 3: `* * * * * wget -O /dev/null -q https://[DOMAIN-NAME]/system/cron/cron.php --no-check-certificate`\n\n### Use custom cron job (contao 4)\n```\n0 3 * * * /path/to/contao/vendor/heimrichhannot/contao-filecredits/bin/indexer # every day at 03:00 \n```\n\n### Use custom cron job (contao 3)\n```\n0 3 * * * /path/to/contao/composer/vendor/heimrichhannot/contao-filecredits/bin/indexer # every day at 03:00 \n```\n\n## Filecredits 3.x\n\nFilecredits 3 yields an huge performance due to credit index within cron job only. Filecredits makes usage of `executeResize` Hook, which is triggered\nevery time an image is resized. If you use responsive images this Hook will be triggered not only once, but for every src-set provided.\nFilecredit 2.x invoked the hook within every client request, which braked down your website performance, based on number of images per page.\nFilecredit 3 now triggers a daily poor mans cron, or you can declare your own cron job within crontab, see Installation. \n\n## Filecredits 2.x\n\nFilecredits 2.x is a complete redevelopment. If you attached your custom modules to filecredits 1.x, we would not recommend to upgrade.\n\n## Features\n\n- Copyrights can be added directly at the file within the contao file manager\n- Page occurrences for images will be added automatically, on rebuild search index, or when the page with the image will be loaded\n- A backend module is available to add custom filecredits with multiple page occurrences.\n- A copyright field can be added to any DCA as a shortcut to add copyrights directly to a file without having to go to the file manager\n\n## Technical instructions\n\n### Adding a copyright field to a non-tl_files-DCA\n\nIf you want to get a shortcut copyright field next to e.g. some image field you can do this by calling the following code e.g. in your DCA:\n\n```\n\\HeimrichHannot\\FileCredit\\FileCredit::addCopyrightFieldToDca(\u003cthe DCA's table name\u003e, \u003cthe name of the copyright field to be created\u003e, \u003cthe name of the linked file field which copyright is being synced\u003e);\n\n// example:\n\\HeimrichHannot\\FileCredit\\FileCredit::addCopyrightFieldToDca('tl_news', 'detailsCopyright', 'detailsSingleSRC');\n```\n\n### Hooks\n\nName | Arguments | Expected return value | Description\n---- | --------- | --------------------- | -----------\n{{copyright::*::,}} | 1: file uuid (string) or file path, 2: credits delimiter (default: ,) | string | Return the file credits for a given uuid or path as delimited string.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheimrichhannot%2Fcontao-filecredits","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheimrichhannot%2Fcontao-filecredits","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheimrichhannot%2Fcontao-filecredits/lists"}