MediaWiki  1.23.6
IORMTable.php
Go to the documentation of this file.
1 <?php
30 interface IORMTable {
38  public function getName();
39 
48  public function getRowClass();
49 
73  public function getFields();
74 
83  public function getDefaults();
84 
94  public function getSummaryFields();
95 
112  public function select( $fields = null, array $conditions = array(),
113  array $options = array(), $functionName = null );
114 
128  public function selectObjects( $fields = null, array $conditions = array(),
129  array $options = array(), $functionName = null );
130 
144  public function rawSelect( $fields = null, array $conditions = array(),
145  array $options = array(), $functionName = null );
146 
169  public function selectFields( $fields = null, array $conditions = array(),
170  array $options = array(), $collapse = true, $functionName = null );
171 
185  public function selectRow( $fields = null, array $conditions = array(),
186  array $options = array(), $functionName = null );
187 
201  public function rawSelectRow( array $fields, array $conditions = array(),
202  array $options = array(), $functionName = null );
203 
221  public function selectFieldsRow( $fields = null, array $conditions = array(),
222  array $options = array(), $collapse = true, $functionName = null );
223 
234  public function has( array $conditions = array() );
235 
243  public function exists();
244 
259  public function count( array $conditions = array(), array $options = array() );
260 
271  public function delete( array $conditions, $functionName = null );
272 
283  public function getAPIParams( $requireParams = false, $setDefaults = false );
284 
294  public function getFieldDescriptions();
295 
303  public function getReadDb();
304 
312  public function setReadDb( $db );
313 
322  public function getTargetWiki();
323 
332  public function setTargetWiki( $wiki );
333 
344  public function getReadDbConnection();
345 
356  public function getWriteDbConnection();
357 
367  public function getLoadBalancer();
368 
379  public function releaseConnection( DatabaseBase $db );
380 
393  public function update( array $values, array $conditions = array() );
394 
403  public function updateSummaryFields( $summaryFields = null, array $conditions = array() );
404 
416  public function getPrefixedValues( array $values );
417 
428  public function getPrefixedFields( array $fields );
429 
439  public function getPrefixedField( $field );
440 
450  public function unprefixFieldNames( array $fieldNames );
451 
461  public function unprefixFieldName( $fieldName );
462 
474  public function getFieldsFromDBResult( stdClass $result );
475 
485  public function newRowFromDBResult( stdClass $result );
486 
497  public function newRow( array $data, $loadDefaults = false );
498 
506  public function getFieldNames();
507 
517  public function canHaveField( $name );
518 }
IORMTable\selectFieldsRow
selectFieldsRow( $fields=null, array $conditions=array(), array $options=array(), $collapse=true, $functionName=null)
Selects the the specified fields of the first record matching the provided conditions and returns it ...
IORMTable\has
has(array $conditions=array())
Returns if there is at least one record matching the provided conditions.
IORMTable\selectFields
selectFields( $fields=null, array $conditions=array(), array $options=array(), $collapse=true, $functionName=null)
Selects the the specified fields of the records matching the provided conditions and returns them as ...
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
IORMTable\rawSelect
rawSelect( $fields=null, array $conditions=array(), array $options=array(), $functionName=null)
Do the actual select.
IORMTable\getPrefixedField
getPrefixedField( $field)
Takes in a field and returns an it's prefixed version, ready for db usage.
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
IORMTable\count
count(array $conditions=array(), array $options=array())
Returns the amount of matching records.
IORMTable\rawSelectRow
rawSelectRow(array $fields, array $conditions=array(), array $options=array(), $functionName=null)
Selects the the specified fields of the records matching the provided conditions.
IORMTable\newRow
newRow(array $data, $loadDefaults=false)
Get a new instance of the class from an array.
IORMTable\getPrefixedFields
getPrefixedFields(array $fields)
Takes in a field or array of fields and returns an array with their prefixed versions,...
IORMTable\getPrefixedValues
getPrefixedValues(array $values)
Takes in an associative array with field names as keys and their values as value.
IORMTable\update
update(array $values, array $conditions=array())
Update the records matching the provided conditions by setting the fields that are keys in the $value...
IORMTable
Definition: IORMTable.php:30
IORMTable\unprefixFieldNames
unprefixFieldNames(array $fieldNames)
Takes an array of field names with prefix and returns the unprefixed equivalent.
IORMTable\newRowFromDBResult
newRowFromDBResult(stdClass $result)
Get a new instance of the class from a database result.
IORMTable\getFields
getFields()
Returns an array with the fields and their types this object contains.
IORMTable\getDefaults
getDefaults()
Returns a list of default field values.
IORMTable\exists
exists()
Checks if the table exists.
IORMTable\getFieldNames
getFieldNames()
Return the names of the fields.
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
IORMTable\canHaveField
canHaveField( $name)
Gets if the object can take a certain field.
IORMTable\getRowClass
getRowClass()
Returns the name of a IORMRow implementing class that represents single rows in this table.
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1530
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
IORMTable\releaseConnection
releaseConnection(DatabaseBase $db)
Releases the lease on the given database connection.
DatabaseBase
Database abstraction object.
Definition: Database.php:219
IORMTable\setTargetWiki
setTargetWiki( $wiki)
Set the ID of the any foreign wiki to use as a target for database operations.
IORMTable\getSummaryFields
getSummaryFields()
Returns a list of the summary fields.
IORMTable\getReadDb
getReadDb()
Get the database type used for read operations.
IORMTable\setReadDb
setReadDb( $db)
Set the database type to use for read operations.
IORMTable\getWriteDbConnection
getWriteDbConnection()
Get the database type used for read operations.
IORMTable\getAPIParams
getAPIParams( $requireParams=false, $setDefaults=false)
Get API parameters for the fields supported by this object.
IORMTable\selectObjects
selectObjects( $fields=null, array $conditions=array(), array $options=array(), $functionName=null)
Selects the the specified fields of the records matching the provided conditions and returns them as ...
IORMTable\getFieldDescriptions
getFieldDescriptions()
Returns an array with the fields and their descriptions.
IORMTable\select
select( $fields=null, array $conditions=array(), array $options=array(), $functionName=null)
Selects the the specified fields of the records matching the provided conditions and returns them as ...
IORMTable\getName
getName()
Returns the name of the database table objects of this type are stored in.
IORMTable\updateSummaryFields
updateSummaryFields( $summaryFields=null, array $conditions=array())
Computes the values of the summary fields of the objects matching the provided conditions.
IORMTable\getFieldsFromDBResult
getFieldsFromDBResult(stdClass $result)
Get an array with fields from a database result, that can be fed directly to the constructor or to se...
IORMTable\getReadDbConnection
getReadDbConnection()
Get the database type used for read operations.
IORMTable\getLoadBalancer
getLoadBalancer()
Get the database type used for read operations.
IORMTable\getTargetWiki
getTargetWiki()
Get the ID of the any foreign wiki to use as a target for database operations.
IORMTable\selectRow
selectRow( $fields=null, array $conditions=array(), array $options=array(), $functionName=null)
Selects the the specified fields of the first matching record.
IORMTable\unprefixFieldName
unprefixFieldName( $fieldName)
Takes a field name with prefix and returns the unprefixed equivalent.