View source for Manual:ApiBase.php/pl

<languages />
{{Outdated2}}
{{MW file|ApiBase.php|includes/api/|class1=ApiBase}}
<span lang="en" dir="ltr" class="mw-content-ltr">The '''<code>{{gitclass|ApiBase}}</code> class''' implements many basic API functions, and is the base of all API classes.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The class functions are divided into several areas of functionality:</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
*'''Module parameters''': Derived classes can define <code>getAllowedParams()</code> to specify which parameters to expect, how to parse and validate them.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
*'''Profiling''': various methods to allow keeping tabs on various tasks and their time costs
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
*'''Self-documentation''': code to allow the API to document its own state
</div>

<span id="Functions"></span>
==Funkcje==

===getAllowedParams()===

<div lang="en" dir="ltr" class="mw-content-ltr">
Specify which parameters are allowed and what requirements are to be imposed on them. See the documentation at the top of {{git file|project=mediawiki/core |file=includes/api/ApiBase.php |line=40 }} for the constants PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, and PARAM_RANGE_ENFORCE. The possible types of parameters are NULL, string, integer, limit, boolean, timestamp, user, or upload. A "user" parameter is a username that is validated using <code>Title::makeTitleSafe()</code>. For boolean parameters, a default value of anything other than 'false' is not allowed.
</div>

Przykład:

<syntaxhighlight lang="php" style="overflow:auto;">
// Title parameter.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ApiBase::PARAM_TYPE => 'string',
                        ApiBase::PARAM_REQUIRED => true
                ),
        );
}
</syntaxhighlight>

{{anchor|getResultProperties() and getFinalResultProperties()}}
<span id="getResultProperties()_and_getFinalResultProperties()"></span>
===getResultProperties() i getFinalResultProperties()===

<div lang="en" dir="ltr" class="mw-content-ltr">
TODO: Describe what these do
</div>

===getResult()===
<div lang="en" dir="ltr" class="mw-content-ltr">
Gets the API result (see {{ll|Manual:ApiResult.php}}).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==Hooks==
</div>
* {{ll|Manual:Hooks/APIGetAllowedParams|APIGetAllowedParams}}

<div lang="en" dir="ltr" class="mw-content-ltr">
Hooks called from this file are listed in the {{ll|Category:MediaWiki hooks included in ApiBase.php}} category.
</div>

<span id="See_also"></span>
==Zobacz też==

<div lang="en" dir="ltr" class="mw-content-ltr">
* [[Special:MyLanguage/API:Implementation Strategy|API Implementation Strategy]]
</div>
* {{ll|API:Extensions}}
* {{ll|Manual:ApiMain.php}}
* {{ll|Manual:Code}}
* {{ll|Manual:Coding conventions}}