{"id":20961909,"url":"https://github.com/heimrichhannot/contao-entity_notifyer","last_synced_at":"2025-08-24T00:16:14.967Z","repository":{"id":62515465,"uuid":"123923135","full_name":"heimrichhannot/contao-entity_notifyer","owner":"heimrichhannot","description":null,"archived":false,"fork":false,"pushed_at":"2018-03-12T08:42:48.000Z","size":14,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-20T00:53:17.241Z","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":"2018-03-05T13:25:46.000Z","updated_at":"2022-09-28T06:23:34.000Z","dependencies_parsed_at":"2022-11-02T13:02:53.847Z","dependency_job_id":null,"html_url":"https://github.com/heimrichhannot/contao-entity_notifyer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-entity_notifyer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-entity_notifyer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-entity_notifyer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimrichhannot%2Fcontao-entity_notifyer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heimrichhannot","download_url":"https://codeload.github.com/heimrichhannot/contao-entity_notifyer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243358306,"owners_count":20277995,"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:18:30.849Z","updated_at":"2025-03-13T07:12:14.023Z","avatar_url":"https://github.com/heimrichhannot.png","language":"PHP","readme":"# Entity Notifyer\n\nThis module is used to send a notification for the subject that an entity hasn't been changed in a while.\n\n\n## Technical instruction\n\n### set up the entity_notifyer\n\n### Step 1\n\n- create a new observer in heimrichhannot\\contao-observer backend module\n- select `entity_notification` as subject in the observer config\n- select a dataContainer\n- select `entity_inactive_notifcation` as observer in the observer config\n- set criteria on which the notification should be send\n\n### Step 2\n\n- create a new entity_notification in heimrichhannot\\contao-entity_notifyer backend module \n- select an previously defined observer \n- choose a notification that should be send when the criteria set in the observer is fullfilled\n\n### optional\n\n- enable the backend user to exclude an entity from the entity notifyer (e.g. this could come to use when a notification has been send a couple of times for that entity and you don't want to get more)\n\n- add `excludeFromEntityNotifyer` field to dca which you want to exclude from the notification\n\n```\n  \\HeimrichHannot\\EntityNotifyer\\Backend\\EntityNotifyerHelper::addExcludeField('tl_member');\n```\n  \n- add the `operation` to the dca\n\n```\n   $dc['list']['operations'][\\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE_FROM_OBSERVER] = [\n       'label'           =\u003e \u0026$GLOBALS['TL_LANG']['OBSERVER'][\\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE][0],\n       'title'           =\u003e \u0026$GLOBALS['TL_LANG']['OBSERVER'][\\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE][1],\n       'href'            =\u003e 'key=' . \\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE,\n       'icon'            =\u003e 'system/modules/entity_observer/assets/img/_icon.png',\n       'button_callback' =\u003e [\n           'HeimrichHannot\\EntityObserver\\Backend\\EntityObserverHelper',\n           \\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE_FROM_OBSERVER\n       ]\n   ]; \n  ```\n\n- add the operation in the `config.php`\n\n```\n// exclude from entity_notifyer\n$GLOBALS['BE_MOD']['accounts']['member'][\\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE] =\n    ['HeimrichHannot\\EntityNotifyer\\Backend\\EntityNotifyerHelper', \\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_EXCLUDE];\n// include to entity_notifyer\n$GLOBALS['BE_MOD']['accounts']['member'][\\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_INCLUDE] =\n    ['HeimrichHannot\\EntityNotifyer\\Backend\\EntityNotifyerHelper', \\HeimrichHannot\\EntityNotifyer\\Entity::ENTITY_NOTIFYER_INCLUDE];\n```\n\n- you can now exclude/include an entity from the functionality of entity_notifyer at the backend entity\n\n\n## Classes\n\nName | Description\n---- | -----------\nEntity | set up constants\nEntityNotifyerHelper | Helper class to get options for dca and handle the exclude/include of entities from entity_notifyer\nEntityInactiveObserver | Observer that can be selected in heimrichhannot/contao-observer config. Sends the notification\nNotificationSubject | Subject that can be selected in heimrichhannot/contao-observer. Notifys the observer wether it should send the notification. Check if entity is excluded from entity_notifyer happens here.\n\n## Hooks\n\nName | Arguments | Expected return value | Description\n---- | --------- | --------------------- | -----------\neditEntityNotificationTokens | $entity,$tokens | $tokens | Modify the tokens used for the notification send by entity_notifyer\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheimrichhannot%2Fcontao-entity_notifyer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheimrichhannot%2Fcontao-entity_notifyer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheimrichhannot%2Fcontao-entity_notifyer/lists"}