{"id":19899364,"url":"https://github.com/perl-workflow/perl-workflow-persister-spops","last_synced_at":"2025-10-03T13:53:03.917Z","repository":{"id":51345295,"uuid":"361510874","full_name":"perl-workflow/perl-workflow-persister-spops","owner":"perl-workflow","description":"This perl-workflow persister was extracted from the core distribution","archived":false,"fork":false,"pushed_at":"2021-05-14T05:53:16.000Z","size":9,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-14T00:00:38.542Z","etag":null,"topics":["perl","perl-module","perl5"],"latest_commit_sha":null,"homepage":"","language":"Perl","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/perl-workflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-04-25T18:46:05.000Z","updated_at":"2022-10-01T09:57:07.000Z","dependencies_parsed_at":"2022-08-26T10:21:24.323Z","dependency_job_id":null,"html_url":"https://github.com/perl-workflow/perl-workflow-persister-spops","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/perl-workflow/perl-workflow-persister-spops","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perl-workflow%2Fperl-workflow-persister-spops","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perl-workflow%2Fperl-workflow-persister-spops/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perl-workflow%2Fperl-workflow-persister-spops/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perl-workflow%2Fperl-workflow-persister-spops/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/perl-workflow","download_url":"https://codeload.github.com/perl-workflow/perl-workflow-persister-spops/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perl-workflow%2Fperl-workflow-persister-spops/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265233753,"owners_count":23731825,"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":["perl","perl-module","perl5"],"created_at":"2024-11-12T20:08:19.158Z","updated_at":"2025-10-03T13:52:58.866Z","avatar_url":"https://github.com/perl-workflow.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nWorkflow::Persister::SPOPS - Persist workflows using SPOPS\n\n# VERSION\n\nThis documentation describes version 1.53 of this package\n\n# SYNOPSIS\n\n    \u003cpersister name=\"SPOPSPersister\"\n               class=\"Workflow::Persister::SPOPS\"\n               workflow_class=\"My::Persist::Workflow\"\n               history_class=\"My::Persist::History\"/\u003e\n\n# DESCRIPTION\n\n## Overview\n\nUse a SPOPS classes to persist your workflow and workflow history\ninformation. Configuration is simple: just specify the class names and\neverything else is done.\n\nWe do not perform any class initialization, so somewhere in your\nserver/process startup code you should have something like:\n\n    my $config = get_workflow_and_history_config();\n    SPOPS::Initialize-\u003eprocess({ config =\u003e $config });\n\nThis will generate the classes named in the persister configuration.\n\n## SPOPS Configuration\n\n**NOTE**: The configuration for your workflow history object **must**\nuse the [SPOPS::Tool::DateConvert](https://metacpan.org/pod/SPOPS%3A%3ATool%3A%3ADateConvert) to translate the 'history\\_date'\nfield into a [DateTime](https://metacpan.org/pod/DateTime) object. We assume when we fetch the history\nobject that this has already been done.\n\n## METHODS\n\n### init ( \\\\%params)\n\nThis method initializes the SPOPS persistance entity.\n\nIt requires that a workflow\\_class and a history\\_class are specified. If not the\ncase [Workflow::Exception](https://metacpan.org/pod/Workflow%3A%3AException)s are thrown.\n\n### create\\_workflow\n\nSerializes a workflow into the persistance entity configured by our workflow.\n\nTakes a single parameter: a workflow object\n\nReturns a single value, a id for unique identification of out serialized\nworkflow for possible deserialization.\n\n### fetch\\_workflow\n\nDeserializes a workflow from the persistance entity configured by our workflow.\n\nTakes a single parameter: the unique id assigned to our workflow upon\nserialization (see [\"create\\_workflow\"](#create_workflow)).\n\nReturns a hashref consisting of two keys:\n\n- state, the workflows current state\n- last\\_update, date indicating last update\n\n### update\\_workflow\n\nUpdates a serialized workflow in the persistance entity configured by our\nworkflow.\n\nTakes a single parameter: a workflow object\n\nReturns: Nothing\n\n### create\\_history\n\nSerializes history records associated with a workflow object\n\nTakes two parameters: a workflow object and an array of workflow history objects\n\nReturns: provided array of workflow history objects upon success\n\n### fetch\\_history\n\nDeserializes history records associated with a workflow object\n\nTakes a single parameter: a workflow object\n\nReturns an array of workflow history objects upon success\n\n# SEE ALSO\n\n- [Workflow::Persister](https://metacpan.org/pod/Workflow%3A%3APersister)\n- [SPOPS](https://metacpan.org/pod/SPOPS)\n- [SPOPS::Tool::DateConvert](https://metacpan.org/pod/SPOPS%3A%3ATool%3A%3ADateConvert)\n\n# COPYRIGHT\n\nCopyright (c) 2003-2021 Chris Winters. All rights reserved.\n\nThis library is free software; you can redistribute it and/or modify\nit under the same terms as Perl itself.\n\nPlease see the `LICENSE`\n\n# AUTHORS\n\nPlease see [Workflow](https://metacpan.org/pod/Workflow)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperl-workflow%2Fperl-workflow-persister-spops","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperl-workflow%2Fperl-workflow-persister-spops","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperl-workflow%2Fperl-workflow-persister-spops/lists"}