Quelltext der Seite Modul:Discipline/class

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

-- ****************************************************************
-- *                         inheritance                          *
-- ****************************************************************
local ClassDiscipline = FoundationClass:subclass('Discipline')
-- setting class's configuration data
ClassDiscipline.static.myConfiguration = mw.loadData('Module:Discipline/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
-- ClassDiscipline.static.myPropertyModule = require('Module:extern')
-- ClassDiscipline.static.staticProperty = ' '

-- remember the static classes provided by Foundationclass:
-- ClassDiscipline.globalConfig
-- ClassDiscipline.myCargoUtil
-- ClassDiscipline.mySmwUtil
-- ClassDiscipline.myTableTools
-- ClassDiscipline.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 ClassDiscipline: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, ' ClassDiscipline: done initializing object &quot;' .. uid ..'&quot;, from ' .. tostring(self))
end

function ClassDiscipline.static:sfGenerateForm()
	_debug(self, 1, 'entering ClassDiscipline.static:sfGenerateForm()')
	local _CFG = self.myConfiguration
	local ClassDisciplineAbility  = require('Module:Discipline/ability/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()
	-- get all fields except the holds_template field
	local mainTab = {}
	for _, field in pairs(_CFG.form.fieldOrder) do
		if field ~= 'discipline_abilities' then
			table.insert(mainTab, field)
		end
	end
	-- 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('__NOGLOSSARY__<h1>Disziplin-Kerndaten</h1>')
		:newline()
		:wikitext(tagStart .. 'for template|' .. _CFG.template.name .. '|label=' .. _CFG.global.entityTitle .. tagEnd)
		:newline()
		:node(self:sfGenerateFormTable(mainTab))
		:wikitext("'''(*) Pflichtfeld'''")
		:newline()
		:wikitext('<h1>Verfügbare Fähigkeiten</h1>')
		:newline()
		:wikitext('<h2>' .. _CFG.parameter.discipline_abilities.label .. '</h2>')
		:newline()
		:wikitext(_CFG.parameter.discipline_abilities.description)
		:newline()
		:node(self:sfInitField('discipline_abilities'):render())
		:newline()
		:wikitext(tagStart .. 'end template' .. tagEnd)
		:newline()
		:wikitext(frame:extensionTag('headertabs'))
		:newline()
		:node(ClassDisciplineAbility:sfGenerateForm(_CFG.template.name .. '[discipline_abilities]'))
		:node(formbuttons)
		:newline()
		:wikitext(tagStart .. 'for template|Navbox discipline' .. tagEnd)
		: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


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

function ClassDiscipline.static:mySfDynamicFieldAttribute(fieldname, attribute, value)
	_debug(self, 1, 'entering ClassDiscipline.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 == 'name' and attribute == 'default' then
		val = mw.title.getCurrentTitle().text
	end
	return val	-- this value will be used as new value for field's attribute
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 ClassDiscipline:addInfobox()
	_debug(self, 1, 'entering ClassDiscipline:addInfobox(), from ' .. tostring(self))
	if false and self:goodToGo() then
		local _CFG = self.class.myConfiguration
		local coreData = self:getCoreData()
		local ib_args = {
			bodyclass = 'infobox_name',
			aboveclass = 'objtitle titletext',
			headerclass = 'headertext',
			labelstyle = 'width: 30%;',
			datastyle = 'width: 70%;',
			title = self:getUid(),
			subheader = nil,
			label1 = _CFG.parameter.name.label,
			data1 = coreData.name and coreData.name or nil,
			header1 = nil,
		}
		self:addOutput(require('Module:Infobox').infobox(ib_args))
		return true
	end
	return false
end

function ClassDiscipline:addPageBody()
	_debug(self, 1, 'entering ClassDiscipline:addPageBody(), from ' .. tostring(self))
	_debug(self, 2, ' rendering errors and warnings and adding them to output')
	local coreData = self:getCoreData()
	local frame = mw.getCurrentFrame()
	-- this is used in conjunction with the extension CSS and the parser function #css to disable the virtual editor on person pages
	local css = [==[
#ca-ve-edit {
  display: none !important;
}
]==]
	frame:callParserFunction('#css:' .. css)
	self:addOutput(self:renderErrors())
	self:addOutput(self:renderWarnings())
	self:setSortkey(coreData.displaytitle)
	if self:goodToGo() then
		-- onpath
		if coreData.path_of and coreData.path_of ~= 'Nein' then
			self:addOutput( frame:callParserFunction('#vardefine:onpath', coreData.path_of) )
		end
		local html = mw.html.create('')
		html:wikitext(coreData.introtext)
			:tag('div')
				:addClass('noautonum')
				:wikitext('__TOC__')
				:done()
				:newline()
			:wikitext(coreData.discipline_abilities)
		self:addOutput(html)
--		self:addOutput(coreData.discipline_abilities)
		return true
	end
	return false
end

function ClassDiscipline:myArgumentProcessing(coreData)
	_debug(self, 1, 'entering ClassDiscipline: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.displaytitle = coreData.name
	-- get all clans, that have this disciplin as their clan disciplin
	-- unused.
	return coreData	-- this is your new coreData.
end

function ClassDiscipline:myDataAdjustments(data)
	_debug(self, 1, 'entering ClassDiscipline: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 ClassDiscipline:myPlausibilityTest(args)
	_debug(self, 1, 'entering ClassDiscipline: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
	return false	-- return value will be ignored. but if you add any error, the object's initialization will fail with the error
end

function ClassDiscipline:myStashAdjustments(stash, storeType)
	_debug(self, 1, 'entering ClassDiscipline: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 ClassDiscipline:method()
	_debug(self, 1, 'entering ClassDiscipline:method() to do something, from ' .. tostring(self))
	return true
end

return ClassDiscipline