Quelltext der Seite Modul:Chapter/class

local FoundationClass = require('Module:Foundationclass')
local ClassDebug = require('Module:Debug/class')

-- ****************************************************************
-- *                         inheritance                          *
-- ****************************************************************
local ClassChapter = FoundationClass:subclass('Chapter')
-- setting class's configuration data
ClassChapter.static.myConfiguration = mw.loadData('Module:Chapter/config')
--   being in a static method, use self.myConfiguration
--   being in a private method, that knows self or in a public method, use self.class.myConfiguration

-- ****************************************************************
-- *                          properties                          *
-- ****************************************************************

-- **************** initialization of table for private properties
local _private = setmetatable({}, {__mode = 'k'})   -- weak table storing all private attributes

-- **************** declaration of public static properties
-- ClassChapter.static.myPropertyModule = require('Module:extern')
-- ClassChapter.static.staticProperty = ' '

-- remember the static classes provided by Foundationclass:
-- ClassChapter.globalConfig
-- ClassChapter.myCargoUtil
-- ClassChapter.mySmwUtil
-- ClassChapter.myTableTools
-- ClassChapter.myYesno

-- **************** declaration of (global) private properties
-- for properties you should rather use constructor and _private[self]. this only, if you need a private class property
-- you should, however predeclare private methods here
local _debug	-- private method declared later
local _privateMethodAhead	-- declaration ahead, so this private method can be used in the constructor and in other private methods

-- ***************************************************************
-- *                           methods                           *
-- ***************************************************************
 
-- **************** declaration of static methods
function ClassChapter:initialize(uid, superhandler)
	local _CFG = self.class.myConfiguration
	FoundationClass.initialize(self, uid, superhandler)
	_private[self] = {
		dbg = ClassDebug:new(tostring(self.class) .. ': id ' .. uid),
	}
	_debug(self, 1, ' ClassChapter: done initializing object &quot;' .. uid ..'&quot;, from ' .. tostring(self))
end

-- use use self.myConfiguration to access your configuration in a static method
function ClassChapter.static:aStaticMethod(var)
	_debug(self, 1, 'entering ClassChapter.static:aStaticMethod() to do something, from ' .. tostring(self))
end

function ClassChapter.static:mySfDynamicFieldAttribute(fieldname, attribute, value)
	_debug(self, 1, 'entering ClassChapter.static:mySfDynamicFieldAttribute(fieldname, attribute, value), from ' .. tostring(self))
	_debug(self, 2, ' with parameters &quot;' .. fieldname .. '&quot;, &quot;' .. attribute .. '&quot; and a ' .. type(value) .. ' value')
	-- function that can process any attribute/value pair just before rendering the semantic forms field
	-- usually done, to generate a dynamic 'default' value
	-- keep in mind: you can completely disable a form field, if you return true on attribute &quot;disable&quot;.
	-- 	however, this causes the parameter to not show at all, neither in the form, nor in processing
	local val = value
	if fieldname == 'number' and attribute == 'default' then
		local query = {
			select = {'[[is_member_of_class::Chapter]]'},
			fields = {'Has_chapter_number'}
		}
		local attributes = {
			limit = 1,
			sort = 'Has_chapter_number',
			order = 'desc',
		}
		local result = ClassChapter.mySmwUtil.ask(query, attributes)
		if result and result[1] and result[1].Has_chapter_number then
			val = result[1].Has_chapter_number
		end
	end
	if fieldname == 'start_date' and attribute == 'default' then
		local query = {
			select = {'[[is_member_of_class::Chapter]]'},
			fields = {'Took_place_until#ISO=date'}
		}
		local attributes = {
			limit = 1,
			sort = 'Took_place_until',
			order = 'desc',
		}
		local result = ClassChapter.mySmwUtil.ask(query, attributes)
		if result and result[1] and result[1].date then
			local lang = mw.language.getContentLanguage()
			local ts = lang:formatDate('U', result[1].date)
			ts = ts + 86400
			val = os.date('%Y/%m/%d', ts)
		end
	end
	return val	-- this value will be used as new value for field's attribute
end

function ClassChapter.static:sfGenerateForm()
	_debug(self, 1, 'entering ClassChapter.static:sfGenerateForm()')
	local _CFG = self.myConfiguration
	local ClassEvent  = require('Module:Event/class')
	local ClassInfo  = require('Module:Info/class')
	local ClassMarker  = require('Module:Marker/class')
	local tagStart = '{{{'
	local tagEnd = '}}}'
	local frame = mw.getCurrentFrame()
	-- create the form header
	local notification = mw.html.create('')
	if _CFG.form.notification and mw.ustring.len(_CFG.form.notification) > 0 then
		notification:wikitext(mbox.main('ombox', { text = _CFG.form.notification }))
			:newline()
	end
	local formheader = mw.html.create('')
	formheader:wikitext(self:sfGenerateFormInfoTag())
		:wikitext('<h2>' .. _CFG.global.entityTitle .. '</h2>')
		:tag('p')
			:wikitext(_CFG.form.headerText)
			:done()
			:newline()
		:node(notification)
		:tag('div')
			:attr('id', 'wikiPreview')
			:cssText('display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;')
			:done()
			:newline()
	-- free text
	local freetext = mw.html.create('')
	if _CFG.form.allowsFreeText then
		freetext:wikitext(tagStart .. 'standard input|free text|autogrow=true|editor=wikieditor|cols=' .. math.min(200, 2*_CFG.form.textareaAttributes.cols) .. 
					'|rows=' .. math.min(24, 3*_CFG.form.textareaAttributes.rows) .. (_CFG.form.freetextPreload and '|preload=' .. _CFG.form.freetextPreload or '' ) .. tagEnd)
			:newline()
	end
	-- create the form buttons
	local formbuttons = mw.html.create('div')
	for _, button in pairs(_CFG.form.buttons) do
		formbuttons:wikitext(tagStart .. 'standard input|' .. button .. tagEnd)
	end
	formbuttons:addClass('formbuttons')
		:done()
	-- assemble everything
	-- start the html object
	local html = mw.html.create('div')	-- we need this div, otherwise the embedded template will fail
	html:node(formheader)
		:wikitext('<h1>Kapitel-Kerndaten</h1>')
		:newline()
		:wikitext(tagStart .. 'for template|' .. _CFG.template.name .. '|label=' .. _CFG.global.entityTitle .. tagEnd)
		:newline()
		:node(self:sfGenerateFormTable(_CFG.form.tab_maindata))
		:wikitext("'''(*) Pflichtfeld'''")
		:newline()
		:wikitext('<h1>Gesammelte Informationen</h1>')
		:newline()
		:wikitext('<h2>' .. _CFG.parameter.gathered_information.label .. '</h2>')
		:newline()
		:wikitext(_CFG.parameter.gathered_information.description)
		:newline()
		:node(self:sfInitField('gathered_information'):render())
		:newline()
		:wikitext('<h1>Bemerkenswerte Ereignisse</h1>')
		:newline()
		:wikitext('<h2>' .. _CFG.parameter.associated_events.label .. '</h2>')
		:newline()
		:wikitext(_CFG.parameter.associated_events.description)
		:newline()
		:node(self:sfInitField('associated_events'):render())
		:newline()
		:wikitext('<h1>Zusätzliche Kartenmarkierungen</h1>')
		:newline()
		:wikitext('<h2>' .. _CFG.parameter.additional_map_marker.label .. '</h2>')
		:newline()
		:wikitext(_CFG.parameter.additional_map_marker.description)
		:newline()
		:node(self:sfInitField('additional_map_marker'):render())
		:newline()
		:wikitext(tagStart .. 'end template' .. tagEnd)
		:newline()
		:wikitext('<h1>Geschehnisse</h1>')
		:newline()
		:node(freetext)
		:newline()
		:wikitext(frame:extensionTag('headertabs'))
		:newline()
		:node(ClassInfo:sfGenerateForm(_CFG.template.name .. '[gathered_information]'))
		:node(ClassEvent:sfGenerateForm(_CFG.template.name .. '[associated_events]'))
		:node(ClassMarker:sfGenerateForm(_CFG.template.name .. '[additional_map_marker]'))
		:node(formbuttons)
		:newline()
		:wikitext(tagStart .. 'for template|Navbox chapter|label=Kapitelnavigationsbox' .. tagEnd)
		:newline()
		:wikitext(tagStart .. 'end template' .. tagEnd)
		:newline()
	local debugLevel = FoundationClass.globalConfig.debugLevel or self.myConfiguration.global.debugLevel
	if debugLevel then
		html:newline()
			:newline()
			:wikitext(ClassDebug:printLog(debugLevel))
	end
	return html
end

-- **************** declaration of private methods
-- use self.class.myConfiguration to access your configuration in a public or a private method that is called by a public method
_debug = function (self, level, text)
	if _private[self] and _private[self].dbg then
		local debugLevel = FoundationClass.globalConfig.debugLevel or self.class.myConfiguration.global.debugLevel
		if debugLevel and level <= debugLevel then
			_private[self].dbg:log(level, text)
		end
	else
		local debugLevel = FoundationClass.globalConfig.debugLevel or self.myConfiguration.global.debugLevel
		if debugLevel and level <= debugLevel then
			ClassDebug:log(level, text, tostring(self) .. '.static')
		end
	end
end

local _privateMethod = function (self)
	_debug(self, 1, 'entering private _privateMethod() to do something, from ' .. tostring(self))
end

-- **************** declaration of public methods
-- use self.class.myConfiguration to access your configuration in a public method
function ClassChapter:addInfobox()
	_debug(self, 1, 'entering ClassChapter:addInfobox(), from ' .. tostring(self))
	if self:goodToGo() then
		local _CFG = self.class.myConfiguration
		local coreData = self:getCoreData()
		local lang = mw.language.getContentLanguage()
		local frame = mw.getCurrentFrame()
		local pcs
		if coreData.pcs and #coreData.pcs > 0 then
			table.sort(coreData.pcs)
			pcs = {}
			for _, pc in pairs(coreData.pcs) do
				table.insert(pcs, ClassChapter:formRedlink(pc, 'Person'))
			end
		end
		local npcs
		if coreData.npcs and #coreData.npcs > 0 then
			table.sort(coreData.npcs)
			npcs = {}
			for _, npc in pairs(coreData.npcs) do
				table.insert(npcs, ClassChapter:formRedlink(npc, 'Person'))
			end
		end
		local args = {}
		args['link text'] = '+'
		args['query string'] = 'Revelation[chapter]=' .. self:getUid()
		local revlink = '(' .. frame:callParserFunction{name = '#formlink', args = args} ..')'
		local ib_args = {
			bodyclass = 'infobox_chapter',
			titleclass = 'objtitle titletext',
			aboveclass = 'objtitle titletext typ_plain',
			headerclass = 'headertext typ_plain',
			labelstyle = 'width: 40%;',
			datastyle = 'width: 60%;',
			title = coreData.title,
			above = 'Kapitel ' .. coreData.number .. ((coreData.subnumber and coreData.subnumber > 0) and '.' .. coreData.subnumber or ''),
			label1 = _CFG.parameter.location.label,
			data1 = coreData.location and '[[' .. coreData.location .. ']]' or nil,
			label2 = 'Zeitraum',
--			data2 = coreData.start_date and lang:formatDate(coreData.start_date, 'd.m.Y') .. (coreData.end_date and '&nbsp;- ' .. lang:formatDate(coreData.end_date, 'd.m.Y') or '') or nil,
			data2 = coreData.start_date and coreData.start_date .. (coreData.end_date and '&nbsp;- ' .. coreData.end_date or '') or nil,
			label5 = _CFG.parameter.pcs.label,
			data5 = pcs and mw.text.listToText(pcs, ', ', ' und ') or nil,
			label6 = _CFG.parameter.npcs.label,
			data6 = npcs and mw.text.listToText(npcs, ', ', ' und ') or nil,
			label8 = _CFG.parameter.auxiliary_settings.label,
			data8 = coreData.auxiliary_settings and '[[' .. mw.text.listToText(coreData.auxiliary_settings, ']], [[', ']] und [[') .. ']]' or nil,
			label9 = 'Offenbarungen',
			data9 = ((coreData.revelations and #coreData.revelations > 0) and '[[' .. mw.text.listToText(coreData.revelations, ']], [[', ']] und [[') .. ']] ' or '') .. revlink,
			data10 = coreData.description,
			header13 = 'Through the looking glass',
			label14 = _CFG.parameter.session_location.label,
			data14 = coreData.session_location and coreData.session_location or nil,
			label15 = _CFG.parameter.session_date.label,
--			data15 = coreData.session_date and lang:formatDate(coreData.session_date, 'd.m.Y') or nil,
			data15 = coreData.session_date and coreData.session_date or nil,
			label16 = _CFG.parameter.session_duration.label,
			data16 = coreData.session_duration and coreData.session_duration or nil,
		}
		self:addOutput(require('Module:Infobox').infobox(ib_args))
		return true
	end
	return false
end

function ClassChapter:addPageBody()
	_debug(self, 1, 'entering ClassChapter:addPageBody(), from ' .. tostring(self))
	_debug(self, 2, ' rendering errors and warnings and adding them to output')
	self:addOutput(self:renderErrors())
	self:addOutput(self:renderWarnings())
	if self:goodToGo() then
		local frame = mw.getCurrentFrame()
		local coreData = self:getCoreData()
		self:addOutput( frame:callParserFunction('#vardefine:number', coreData.number) )
		return true
	end
	return false
end

function ClassChapter:myArgumentProcessing(coreData)
	_debug(self, 1, 'entering ClassChapter:myArgumentProcessing(args) to process coreData, from ' .. tostring(self))
	-- function that performs some individual transformation args --&amp;gt; coreData
	-- remember: you can add warnings to your output with self:addWarning(warning). the page, however, will not be put in any gardening category. for that, use self:addError()
	-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
	local coreData = coreData
	coreData.number = tostring(coreData.number)
	if mw.ustring.find(coreData.number, '[^0-9]') then
		coreData.number, coreData.subnumber = mw.ustring.match(coreData.number, '^([0-9]+)[^0-9]([0-9]+)$')
		coreData.subnumber = tonumber(coreData.subnumber)
	else
		coreData.subnumber = 0
	end
	coreData.number = tonumber(coreData.number)
	-- calculate displaytitle
	coreData.displaytitle = coreData.number .. (coreData.subnumber > 0 and '.' .. coreData.subnumber or '') .. ' ' .. coreData.title
	-- get a list of revelations that were obtained during this chapter
	local query = {
		select = { '[[is_member_of_class::Revelation]]', '[[received_in_chapter::' .. self:getUid() .. ']]' },
		fields = { 'Has_display_title=title' }
	}
	local result = ClassChapter.mySmwUtil.ask(query, {})
	local revelations = {}
	if result and #result > 0 then
		for _, data in pairs(result) do
			table.insert(revelations, data.MainLabel)
		end
	end
	return coreData	-- this is your new coreData.
end

function ClassChapter:myDataAdjustments(data)
	_debug(self, 1, 'entering ClassChapter:myDataAdjustments(data) to convert data from data store into data suitable for argument processing, from ' .. tostring(self))
	-- function that performs some individual transformation datastore data into argument data
	-- keep in mind, when using smw data store, that data is indexed by parameter names, not properties
	-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
	local data = data
	return data	-- this is your new data table, being passed on to initFromArgs and subsequently to plausibility testing
end

function ClassChapter:myPlausibilityTest(args)
	_debug(self, 1, 'entering ClassChapter:myPlausibilityTest(args) to test arguments, from ' .. tostring(self))
	-- function that performs the individual plausibility tests
	-- note: before you access a field args.fieldname you should check for existance
	-- use self:addError(text); this also puts the page in its class's gardening category
	local _CFG = self.class.myConfiguration
	if args.number then
		args.number = tostring(args.number)
		if not mw.ustring.match(args.number, '^[0-9]+$') and not mw.ustring.match(args.number, '^[0-9]+[^0-9][0-9]+$') then
			self:addError('Ungültiger Wert für ' .. _CFG.parameter.number.label .. ' festgestellt: ' .. tostring(args.number))
		end
	end
	return false	-- return value will be ignored. but if you add any error, the object's initialization will fail with the error
end

function ClassChapter:myStashAdjustments(stash, storeType)
	_debug(self, 1, 'entering ClassChapter:myStashAdjustments(stash) to do some minor adjustments on data before storing, from ' .. tostring(self))
	-- function that alters the stash before storing the data. if necessary, you can complate skip storing this stash, if you return false or the empty table {}
	-- storeType is the actual method of storage for this call. either 'cargo', or 'smw'
	-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
	local stash = stash
	return stash	-- this is your new stash. this will be stored. it has format (fieldname: value)
end

function ClassChapter:method()
	_debug(self, 1, 'entering ClassChapter:method() to do something, from ' .. tostring(self))
	return true
end

return ClassChapter