jenkins-bot has submitted this change and it was merged. Change subject: Document checklist for extending entities. ......................................................................
Document checklist for extending entities. Change-Id: I1b0f7c3d1c58227b3326240fb2a1bbd1e58535a7 --- A docs/extending-entities.wiki 1 file changed, 24 insertions(+), 0 deletions(-) Approvals: Ladsgroup: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/extending-entities.wiki b/docs/extending-entities.wiki new file mode 100644 index 0000000..bda520b --- /dev/null +++ b/docs/extending-entities.wiki @@ -0,0 +1,24 @@ +This is a checklist of things that need doing when adding a new field to an existing entity type. + +* Add a provider interface, such as NewThingyProvider, for the new field. +* Add to entity as an attribute and add getter and setter (implement the provider interface) +* Add to content as part of FooContent::isStub +* Add to Special:NewFoo if needed upon creation +* Consider in equals() method of the Entity +* Consider in __clone() method of the Entity +* Consider in isEmpty() method of the Entity +* Add support to FooSerializer +* Add support to FooDeserializer +* Add support to FooPatcher +* Add support to FooDiffer +* Add support in FooView (extends EntityView) + +CAVEAT (as of November 2016): For the below parts of Wikibase, there are no extension +interfaces yet for handling additional fields of entities. Fields of entity types known +to Wikibase itself can be hardcoded here, but for supporting entity types defined in +other extensions, plug-in interfaces still need to be added. + +* Add to RDF mapping (not currently pluggable!) +* Add Validator (not currently pluggable) +* Add ChangeOp for updating (not currently pluggable) (must work with wbeditentity) +* Add handling (or suppression) to EntityChangeFactory (not currently pluggable) \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/323402 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I1b0f7c3d1c58227b3326240fb2a1bbd1e58535a7 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/Wikibase Gerrit-Branch: master Gerrit-Owner: Daniel Kinzler <[email protected]> Gerrit-Reviewer: Aude <[email protected]> Gerrit-Reviewer: Daniel Kinzler <[email protected]> Gerrit-Reviewer: Hoo man <[email protected]> Gerrit-Reviewer: Ladsgroup <[email protected]> Gerrit-Reviewer: Thiemo Mättig (WMDE) <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
