WikibaseLexeme
MediaWiki WikibaseLexeme extension
Loading...
Searching...
No Matches
Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator Class Reference

Public Member Functions

 __construct ( $aggregateAction)
 
 overrideSummary (Summary $summary, Summary $subSummary)
 Change the $summary to reflect the aggregation result of $summary and $subSummary.
 
 aggregate (Summary $summary, Summary $subSummary)
 Get a Summary that contains the aggregation result of $summary and $subSummary.
 

Private Member Functions

 hasNothingToMerge (Summary $summary)
 
 isAlreadyAggregate (Summary $summary)
 
 hasNoExistingSummary (Summary $summary)
 
 haveDifferentActions (Summary $summary, Summary $subSummary)
 
 createDifferentActionAggregation (Summary $summary, Summary $subSummary)
 
 createSameActionAggregation (Summary $summary, Summary $subSummary)
 

Private Attributes

 $aggregateAction
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::__construct ( $aggregateAction)
Parameters
string$aggregateActionThe name to use to describe the aggregation action in Summary

Member Function Documentation

◆ aggregate()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::aggregate ( Summary $summary,
Summary $subSummary )

Get a Summary that contains the aggregation result of $summary and $subSummary.

Parameters
Summary$summary
Summary$subSummary
Returns
Summary

◆ createDifferentActionAggregation()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::createDifferentActionAggregation ( Summary $summary,
Summary $subSummary )
private

◆ createSameActionAggregation()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::createSameActionAggregation ( Summary $summary,
Summary $subSummary )
private

◆ hasNoExistingSummary()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::hasNoExistingSummary ( Summary $summary)
private

◆ hasNothingToMerge()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::hasNothingToMerge ( Summary $summary)
private

◆ haveDifferentActions()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::haveDifferentActions ( Summary $summary,
Summary $subSummary )
private

◆ isAlreadyAggregate()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::isAlreadyAggregate ( Summary $summary)
private

◆ overrideSummary()

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::overrideSummary ( Summary $summary,
Summary $subSummary )

Change the $summary to reflect the aggregation result of $summary and $subSummary.

Helps if you have a reference to an existing object http://php.net/manual/en/language.oop5.references.php

Parameters
Summary$summary
Summary$subSummary

Member Data Documentation

◆ $aggregateAction

Wikibase\Lexeme\MediaWiki\Api\Summary\SummaryAggregator::$aggregateAction
private

The documentation for this class was generated from the following file: