Plugin:MirLua/Module/m database - Revision history

Dart Raiden: Marked this version for translation

2022-02-09T23:03:08Z

Marked this version for translation

Goraf: minor rephrase

2018-06-03T08:05:00Z

minor rephrase

← Older revision		Revision as of 11:05, 3 June 2018
Line 260:		Line 260:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 296:		Line 296:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 327:		Line 327:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=db.DeleteModule(nil, 'test')}}		{{Content:MirLua/Example\|code=db.DeleteModule(nil, 'test')}}

Goraf: add langbar

2018-06-02T15:14:20Z

add langbar

← Older revision		Revision as of 18:14, 2 June 2018
Line 1:		Line 1:
			<languages/>
	<translate>		<translate>
	Allows you to access data and contacts in user profile database.		Allows you to access data and contacts in user profile database.

Goraf: make it translatable; some functions are missing

2018-06-02T13:44:38Z

make it translatable; some functions are missing

Show changes

Goraf: Goraf moved page Plugin:MirLua/en/m database to Plugin:MirLua/Module/m database: to transform to translation system

2018-06-02T10:50:02Z

Goraf moved page Plugin:MirLua/Module/m database to Plugin:MirLua/Module/m database: to transform to translation system

← Older revision		Revision as of 13:50, 2 June 2018
(No difference)

Unsane at 18:56, 31 December 2015

2015-12-31T18:56:06Z

← Older revision		Revision as of 21:56, 31 December 2015
Line 10:		Line 10:

	== Contacts ==		== Contacts ==
	=== ~~AllContacts~~ ===		=== Contacts ===
	Iterator for list of contacts.		Iterator for list of contacts.
	;Parameters		;Parameters
Line 21:		Line 21:
	;Example		;Example
	{{Content:MirLua/Example\|code=		{{Content:MirLua/Example\|code=
	for hContact in db.~~AllContacts~~('JABBER_1') do		for hContact in db.Contacts('JABBER_1') do
	print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))		print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
	end		end
Line 40:		Line 40:
	{{Content:MirLua/Example\|code=db.GetEventCount(hContact)}}		{{Content:MirLua/Example\|code=db.GetEventCount(hContact)}}

	=== ~~AllEvents~~ ===		=== Events ===
	Iterator for contact's event list from the first to the last.		Iterator for contact's event list from the first to the last.
	;Parameters		;Parameters
Line 50:		Line 50:
	: Returns event number. The list ends in element with '''nil''' value.		: Returns event number. The list ends in element with '''nil''' value.
	;Example		;Example
	{{Content:MirLua/Example\|code=for hEvent in db.~~AllEvents~~(hContact) do		{{Content:MirLua/Example\|code=for hEvent in db.Events(hContact) do
	local event = totable(hEvent, "DBEVENTINFO")		local event = totable(hEvent, "DBEVENTINFO")
	print(event.Timestamp, event.Blob)		print(event.Timestamp, event.Blob)
Line 56:		Line 56:
	}}		}}

	=== ~~AllEventsFromEnd~~ ===		=== EventsFromEnd ===
	Iterator for contact's event list from the last to the first.		Iterator for contact's event list from the last to the first.
	;Parameters		;Parameters
Line 67:		Line 67:
	;Example		;Example
	{{Content:MirLua/Example\|code=		{{Content:MirLua/Example\|code=
	for hEvent in db.~~AllEventsFromEnd~~(hContact) do		for hEvent in db.EventsFromEnd(hContact) do
	local event = totable(hEvent, "DBEVENTINFO")		local event = totable(hEvent, "DBEVENTINFO")
	print(event.Timestamp, event.Blob)		print(event.Timestamp, event.Blob)
Line 96:		Line 96:
	{{Content:MirLua/Example\|code=db.GetSetting(nil, 'test', 'some')}}		{{Content:MirLua/Example\|code=db.GetSetting(nil, 'test', 'some')}}

	=== ~~AllSettings~~ ===		=== Settings ===
	Iterator for module (group of settings).		Iterator for module (group of settings).
	;Parameters		;Parameters
Line 110:		Line 110:
	;Example		;Example
	{{Content:MirLua/Example\|code=		{{Content:MirLua/Example\|code=
	for setting in db.~~AllSettings~~(nil, 'CList') do		for setting in db.Settings(nil, 'CList') do
	local message = string.format("%s/%s = ", 'CList', setting, ...)		local message = string.format("%s/%s = ", 'CList', setting, ...)
	.. db.GetSetting(nil, 'CList', setting)		.. db.GetSetting(nil, 'CList', setting)

RMN: double pipes

2015-12-16T18:14:45Z

double pipes

← Older revision		Revision as of 21:14, 16 December 2015
Line 20:		Line 20:
	: Returns contact number. The list ends in element with '''nil''' value.		: Returns contact number. The list ends in element with '''nil''' value.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=		{{Content:MirLua/Example\|code=
	for hContact in db.AllContacts('JABBER_1') do		for hContact in db.AllContacts('JABBER_1') do
	print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))		print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
Line 38:		Line 38:
	: Returns number of events.		: Returns number of events.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=db.GetEventCount(hContact)}}		{{Content:MirLua/Example\|code=db.GetEventCount(hContact)}}

	=== AllEvents ===		=== AllEvents ===
Line 50:		Line 50:
	: Returns event number. The list ends in element with '''nil''' value.		: Returns event number. The list ends in element with '''nil''' value.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=for hEvent in db.AllEvents(hContact) do		{{Content:MirLua/Example\|code=for hEvent in db.AllEvents(hContact) do
	local event = totable(hEvent, "DBEVENTINFO")		local event = totable(hEvent, "DBEVENTINFO")
	print(event.Timestamp, event.Blob)		print(event.Timestamp, event.Blob)
Line 66:		Line 66:
	: Returns event number. The list ends in element with '''nil''' value.		: Returns event number. The list ends in element with '''nil''' value.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=		{{Content:MirLua/Example\|code=
	for hEvent in db.AllEventsFromEnd(hContact) do		for hEvent in db.AllEventsFromEnd(hContact) do
	local event = totable(hEvent, "DBEVENTINFO")		local event = totable(hEvent, "DBEVENTINFO")
Line 94:		Line 94:
	: Returns value of a setting or default value or '''nil'''.		: Returns value of a setting or default value or '''nil'''.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=db.GetSetting(nil, 'test', 'some')}}		{{Content:MirLua/Example\|code=db.GetSetting(nil, 'test', 'some')}}

	=== AllSettings ===		=== AllSettings ===
Line 109:		Line 109:
	: Returns module name. The list ends in element with '''nil''' value.		: Returns module name. The list ends in element with '''nil''' value.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=		{{Content:MirLua/Example\|code=
	for setting in db.AllSettings(nil, 'CList') do		for setting in db.AllSettings(nil, 'CList') do
	local message = string.format("%s/%s = ", 'CList', setting, ...)		local message = string.format("%s/%s = ", 'CList', setting, ...)
Line 133:		Line 133:
	: Returns '''true''' in case of success, else '''false'''.		: Returns '''true''' in case of success, else '''false'''.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=db.WriteSetting(nil, 'test', 'some', true)}}		{{Content:MirLua/Example\|code=db.WriteSetting(nil, 'test', 'some', true)}}

	=== DeleteSetting ===		=== DeleteSetting ===
Line 151:		Line 151:
	: Returns '''true''' in case of success, else '''false'''.		: Returns '''true''' in case of success, else '''false'''.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=db.DeleteSetting(nil, 'test', 'some')}}		{{Content:MirLua/Example\|code=db.DeleteSetting(nil, 'test', 'some')}}

	=== DeleteModule ===		=== DeleteModule ===
Line 166:		Line 166:
	: Returns '''true''' in case of success, else '''false'''.		: Returns '''true''' in case of success, else '''false'''.
	;Example		;Example
	{{Content:MirLua/Example\|\|code=db.DeleteModule(nil, 'test')}}		{{Content:MirLua/Example\|code=db.DeleteModule(nil, 'test')}}

	[[Category:Tutorials (en)]]		[[Category:Tutorials (en)]]

RMN: Plugin:MirLua/en/m_database - bad English - needs revision

2015-12-10T19:34:20Z

Plugin:MirLua/en/m_database - bad English - needs revision

New page

{{PageLang|en}}
Allows you to access data and contacts in user profile database.

Include module: <code>local db = require('m_database')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Contacts ==
=== AllContacts ===
Iterator for list of contacts.
;Parameters
: ''name''
:: Type: '''string'''
:: Protocol name.
;Result
: Type: '''number'''
: Returns contact number. The list ends in element with '''nil''' value.
;Example
{{Content:MirLua/Example||code=
for hContact in db.AllContacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== Events ==
=== GetEventCount ===
Number of events for a contact.
;Parameters
: '''''hContact'''''
:: Type: '''number'''
:: Contact number.
;Result
: Type: '''number'''
: Returns number of events.
;Example
{{Content:MirLua/Example||code=db.GetEventCount(hContact)}}

=== AllEvents ===
Iterator for contact's event list from the first to the last.
;Parameters
: '''''hContact'''''
:: Type: '''number'''
:: Contact number.
;Result
: Type: '''number'''
: Returns event number. The list ends in element with '''nil''' value.
;Example
{{Content:MirLua/Example||code=for hEvent in db.AllEvents(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== AllEventsFromEnd ===
Iterator for contact's event list from the last to the first.
;Parameters
: '''''hContact'''''
:: Type: '''number'''
:: Contact number.
;Result
: Type: '''number'''
: Returns event number. The list ends in element with '''nil''' value.
;Example
{{Content:MirLua/Example||code=
for hEvent in db.AllEventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Settings ==
=== GetSetting ===
Returns value of a setting.
;Parameters
: ''hContact''
:: Type: '''number'''
:: Contact number or '''nil'''.
: '''''module'''''
:: Type: '''string'''
:: Module name.
: '''''setting'''''
:: Type: '''string'''
:: Setting name.
: ''value''
:: Type: '''number''', '''string'''
:: Default value.
;Result
: Type: '''number'''
: Returns value of a setting or default value or '''nil'''.
;Example
{{Content:MirLua/Example||code=db.GetSetting(nil, 'test', 'some')}}

=== AllSettings ===
Iterator for module (group of settings).
;Parameters
: ''hContact''
:: Type: '''number'''
:: Contact number or '''nil'''.
: '''''module'''''
:: Type: '''string'''
:: Module name.
;Result
: Type: '''number'''
: Returns module name. The list ends in element with '''nil''' value.
;Example
{{Content:MirLua/Example||code=
for setting in db.AllSettings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Saves a value to database.
;Parameters
: ''hContact''
:: Type: '''number'''
:: Contact number or '''nil'''.
: '''''module'''''
:: Type: '''string'''
:: Module name.
: '''''setting'''''
:: Type: '''string'''
:: Setting name.
;Result
: Type: '''boolean'''
: Returns '''true''' in case of success, else '''false'''.
;Example
{{Content:MirLua/Example||code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Deletes a setting.
;Parameters
: ''hContact''
:: Type: '''number'''
:: Contact number or '''nil'''.
: '''''module'''''
:: Type: '''string'''
:: Module name.
: '''''setting'''''
:: Type: '''string'''
:: Setting name.
;Result
: Type: '''boolean'''
: Returns '''true''' in case of success, else '''false'''.
;Example
{{Content:MirLua/Example||code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Deletes a module (group of settings).
;Parameters
: ''hContact''
:: Type: '''number'''
:: Contact number or '''nil'''.
: '''''module'''''
:: Type: '''string'''
:: Module name.
;Result
: Type: '''boolean'''
: Returns '''true''' in case of success, else '''false'''.
;Example
{{Content:MirLua/Example||code=db.DeleteModule(nil, 'test')}}

[[Category:Tutorials (en)]]

← Older revision		Revision as of 11:05, 3 June 2018
Line 260:		Line 260:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 296:		Line 296:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 327:		Line 327:
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}} <code>boolean</code>

	{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> ~~in case of~~ success, ~~else~~ <tvar\|false><code>false</code></>.</translate>		{{nbsp\|5}}<translate>Returns <tvar\|true><code>true</code></> on success, otherwise <tvar\|false><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=db.DeleteModule(nil, 'test')}}		{{Content:MirLua/Example\|code=db.DeleteModule(nil, 'test')}}