Manual:ApiBase.php

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:ApiBase.php and the translation is 100% complete.

ApiBase sınıfı birçok temel API işlevini uygular ve tüm API sınıflarının temelidir. Sınıf işlevleri, çeşitli işlev alanlarına ayrılmıştır:

  • Modül parametreleri: Türetilmiş sınıflar, hangi parametrelerin bekleneceğini, bunların nasıl ayrıştırılacağını ve doğrulanacağını belirlemek için getAllowedParams() öğesini tanımlayabilir.
  • Profil oluşturma: çeşitli görevler ve zaman maliyetlerinde sekmelerin tutulmasına izin veren çeşitli yöntemler
  • Kendinden belgelendirme: API'nin kendi durumunu belgelemesine izin veren kod

İşlevler

getAllowedParams()

Hangi parametrelere izin verildiğini ve bunlara hangi gereksinimlerin uygulanacağını belirleyin. PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, ve PARAM_REPRE, (PARAM_REQUIRED, ve PARAM_REPRE,). Olası parametre türleri NULL, string, integer, limit, boolean, zaman damgası, kullanıcı veya yüklemedir. Bir "user" parametresi, Title::makeTitleSafe() kullanılarak doğrulanmış bir kullanıcı adıdır. Boolean parametreler için 'false' dışında bir değerin varsayılan değerine izin verilmez.

Örnek:

// Title parameter.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ApiBase::PARAM_TYPE => 'string',
                        ApiBase::PARAM_REQUIRED => true
                ),
        );
}

getResultProperties() ve getFinalResultProperties()

Yapılacak: Bunların ne yaptığını açıkla

getResult()

API sonucunu alır (bkz Manual:ApiResult.php).

Kancalar

Bu dosyadan çağrılan kancalar Category:MediaWiki hooks included in ApiBase.php kategorisinde listelenmiştir.

Ayrıca bakınız