Making a plugin

[Tim Schofield]

Hi Dan

I was hoping you could help me with writing an AtoM plugin. I want to make sure
I'm doing this right, by overiding templates etc. and staying away from anything that might be core code.

I've been trying to make plugin that records the name of the current user,
the date and time and archival description title when an archival description is created/edited.
I've succeded in makeing a plugin that can be switched on/off and I can get the current logged in user, time and title.
However I don't know where to put the code to save the user, time and title, when an archive description is created/saved.
In WordPress suppose you would look for a "hook" but I'm not aware of an eqivalent notion in AtoM.
Would I do this by overiding a class somewhere?

Regards

Tim Schofield

[Dan Gillean]

Hi Tim, 

I will try to get a developer to review this thread and add a couple suggestions as to where to look next. In the meantime, I'll just re-post some of our development resources here. Apologies in advance if I'm sharing things you're already looking at - I'm also trying to ensure that this thread is useful to future AtoM users searching the forum :)

First, there are those resources listed on the wiki, here: 

• https://wiki.accesstomemory.org/Development#Development_resources
  

See also the roundup of other links here: 

• https://wiki.accesstomemory.org/Development/Recommendations
  

We also have some slides that might be of use: 

• https://www.slideshare.net/accesstomemory/get-to-know-atoms-codebase
  
• https://www.slideshare.net/accesstomemory/atom-feature-development
  
• https://www.slideshare.net/accesstomemory/constructing-sql-queries-for-atom
  
• https://www.slideshare.net/accesstomemory/creating-custom-themes-in-atom
  

You'll also want to look at the Symfony 1.x documentation, which can be found here: 

• https://symfony.com/legacy/doc
  

See for example: 

• On Plugins: https://symfony.com/legacy/doc/jobeet/1_4/en/20?orm=Propel
• A lot of useful info on plugins starting half-way down this page: https://symfony.com/legacy/doc/gentle-introduction/1_4/en/17-Extending-Symfony
• More on creating forms: https://symfony.com/legacy/doc/more-with-symfony/1_4/en/06-Advanced-Forms

If you are storing information that requires new fields to be added to the database, then you will need to add a migration schema, so users can upgrade the database schema by running the tools:upgrade-sql task. You can look at previous migration files here: 

• https://github.com/artefactual/atom/tree/qa/2.5.x/lib/task/migrate/migrations
  

Here's an example of a pull request that added new fields to the view pages, edit pages, facets on the authority record browse page, and import/export code - the addition of new fields on authority records to capture actor occupation data, added to the 2.4.0 release: 

• https://github.com/artefactual/atom/pull/560
  

Looking at what files where changed, where, and how, might be useful for reference, though your project is somewhat different. 

I'll see if our developers can offer any further guidance. 

Regards, 

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

--
You received this message because you are subscribed to the Google Groups "AtoM Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-users+unsubscribe@googlegroups.com.
To post to this group, send email to ica-atom-users@googlegroups.com.
Visit this group at https://groups.google.com/group/ica-atom-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/8a7b9551-74c8-4201-b0aa-8d3b8e8d5391%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.