ApiFormatFeedWrapper Class Reference
This printer is used to wrap an instance of the Feed class. More...
Inheritance diagram for ApiFormatFeedWrapper:
Collaboration diagram for ApiFormatFeedWrapper:
Public Member Functions | |
| __construct (ApiMain $main) | |
| canPrintErrors () | |
| ChannelFeed doesn't give us a method to print errors in a friendly manner, so just punt errors to the default printer. More... | |
| execute () | |
| This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances. More... | |
| getMimeType () | |
| Feed does its own headers. More... | |
| initPrinter ( $unused=false) | |
| This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances. More... | |
 Public Member Functions inherited from ApiFormatBase | |
| __construct (ApiMain $main, $format) | |
| If $format ends with 'fm', pretty-print the output in HTML. More... | |
| closePrinter () | |
| Finish printing and output buffered data. More... | |
| disable () | |
| Disable the formatter. More... | |
| forceDefaultParams () | |
| Ignore request parameters, force a default. More... | |
| getAllowedParams () | |
| Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. More... | |
| getBuffer () | |
| Get the contents of the buffer. More... | |
| getFilename () | |
| Return a filename for this module's output. More... | |
| getFormat () | |
| Get the internal format name. More... | |
| getHelpUrls () | |
| Return links to more detailed help pages about the module. More... | |
| getIsHtml () | |
| Returns true when the HTML pretty-printer should be used. More... | |
| isDisabled () | |
| Whether the printer is disabled. More... | |
| printText ( $text) | |
| Append text to the output buffer. More... | |
| setHttpStatus ( $code) | |
| Set the HTTP status code to be used for the response. More... | |
| Public Member Functions inherited from ApiBase | |
| __construct (ApiMain $mainModule, $moduleName, $modulePrefix='') | |
| getModuleManager () | |
| Get the module manager, or null if this module has no sub-modules. More... | |
| getCustomPrinter () | |
| If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More... | |
| shouldCheckMaxlag () | |
| Indicates if this module needs maxlag to be checked. More... | |
| isReadMode () | |
| Indicates whether this module requires read rights. More... | |
| isWriteMode () | |
| Indicates whether this module requires write mode. More... | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. More... | |
| isDeprecated () | |
| Indicates whether this module is deprecated. More... | |
| isInternal () | |
| Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More... | |
| needsToken () | |
| Returns the token type this module requires in order to execute. More... | |
| getConditionalRequestData ( $condition) | |
| Returns data for HTTP conditional request mechanisms. More... | |
| getModuleName () | |
| Get the name of the module being executed by this instance. More... | |
| getModulePrefix () | |
| Get parameter prefix (usually two letters or an empty string). More... | |
| getMain () | |
| Get the main module. More... | |
| isMain () | |
| Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More... | |
| getParent () | |
| Get the parent of this module. More... | |
| lacksSameOriginSecurity () | |
| Returns true if the current request breaks the same-origin policy. More... | |
| getModulePath () | |
| Get the path to this module. More... | |
| getModuleFromPath ( $path) | |
| Get a module from its module path. More... | |
| getResult () | |
| Get the result object. More... | |
| getErrorFormatter () | |
| Get the error formatter. More... | |
| getContinuationManager () | |
| Get the continuation manager. More... | |
| setContinuationManager ( $manager) | |
| Set the continuation manager. More... | |
| dynamicParameterDocumentation () | |
| Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More... | |
| encodeParamName ( $paramName) | |
| This method mangles parameter name based on the prefix supplied to the constructor. More... | |
| extractRequestParams ( $parseLimit=true) | |
| Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More... | |
| requireOnlyOneParameter ( $params, $required) | |
| Die if none or more than one of a certain set of parameters is set and not false. More... | |
| requireMaxOneParameter ( $params, $required) | |
| Die if more than one of a certain set of parameters is set and not false. More... | |
| requireAtLeastOneParameter ( $params, $required) | |
| Die if none of a certain set of parameters is set and not false. More... | |
| requirePostedParameters ( $params, $prefix='prefix') | |
| Die if any of the specified parameters were found in the query part of the URL rather than the post body. More... | |
| getTitleOrPageId ( $params, $load=false) | |
| Get a WikiPage object from a title or pageid param, if possible. More... | |
| getTitleFromTitleOrPageId ( $params) | |
| Get a Title object from a title or pageid param, if possible. More... | |
| validateToken ( $token, array $params) | |
| Validate the supplied token. More... | |
| getWatchlistUser ( $params) | |
| Gets the user for whom to get the watchlist. More... | |
| errorArrayToStatus (array $errors, User $user=null) | |
| Turn an array of message keys or key+param arrays into a Status. More... | |
| addWarning ( $msg, $code=null, $data=null) | |
| Add a warning for this module. More... | |
| addDeprecation ( $msg, $feature, $data=[]) | |
| Add a deprecation warning for this module. More... | |
| addError ( $msg, $code=null, $data=null) | |
| Add an error for this module without aborting. More... | |
| addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error']) | |
| Add warnings and/or errors from a Status. More... | |
| dieWithError ( $msg, $code=null, $data=null, $httpCode=null) | |
| Abort execution with an error. More... | |
| dieWithException ( $exception, array $options=[]) | |
| Abort execution with an error derived from an exception. More... | |
| dieBlocked (Block $block) | |
| Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More... | |
| dieStatus (StatusValue $status) | |
| Throw an ApiUsageException based on the Status object. More... | |
| dieReadOnly () | |
| Helper function for readonly errors. More... | |
| checkUserRightsAny ( $rights, $user=null) | |
| Helper function for permission-denied errors. More... | |
| checkTitleUserPermissions (Title $title, $actions, $user=null) | |
| Helper function for permission-denied errors. More... | |
| dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null) | |
| Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More... | |
| logFeatureUsage ( $feature) | |
| Write logging information for API features to a debug log, for usage analysis. More... | |
| getFinalSummary () | |
| Get final module summary. More... | |
| getFinalDescription () | |
| Get final module description, after hooks have had a chance to tweak it as needed. More... | |
| getFinalParams ( $flags=0) | |
| Get final list of parameters, after hooks have had a chance to tweak it as needed. More... | |
| getFinalParamDescription () | |
| Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More... | |
| modifyHelp (array &$help, array $options, array &$tocData) | |
| Called from ApiHelp before the pieces are joined together and returned. More... | |
| getModuleProfileName ( $db=false) | |
| profileIn () | |
| profileOut () | |
| safeProfileOut () | |
| getProfileTime () | |
| profileDBIn () | |
| profileDBOut () | |
| getProfileDBTime () | |
| setWarning ( $warning) | |
| dieUsage ( $description, $errorCode, $httpRespCode=0, $extradata=null) | |
| Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message. More... | |
| getErrorFromStatus ( $status, &$extraData=null) | |
| Get error (as code, string) from a Status object. More... | |
| parseMsg ( $error) | |
| Return the error message related to a certain array. More... | |
| dieUsageMsg ( $error) | |
| Output the error message related to a certain array. More... | |
| dieUsageMsgOrDebug ( $error) | |
| Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More... | |
| Public Member Functions inherited from ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). More... | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. More... | |
| getConfig () | |
| Get the Config object. More... | |
| getContext () | |
| Get the base IContextSource object. More... | |
| getLanguage () | |
| Get the Language object. More... | |
| getOutput () | |
| Get the OutputPage object. More... | |
| getRequest () | |
| Get the WebRequest object. More... | |
| getSkin () | |
| Get the Skin object. More... | |
| getStats () | |
| Get the Stats object. More... | |
| getTiming () | |
| Get the Timing object. More... | |
| getTitle () | |
| Get the Title object. More... | |
| getUser () | |
| Get the User object. More... | |
| getWikiPage () | |
| Get the WikiPage object. More... | |
| msg ( $key) | |
| Get a Message object with context set Parameters are the same as wfMessage() More... | |
| setContext (IContextSource $context) | |
| Set the IContextSource object. More... | |
Static Public Member Functions | |
| static | setResult ( $result, $feed, $feedItems) |
| Call this method to initialize output data. More... | |
| Static Public Member Functions inherited from ApiBase | |
| static | truncateArray (&$arr, $limit) |
| Truncate an array to a certain length. More... | |
| static | makeMessage ( $msg, IContextSource $context, array $params=null) |
| Create a Message from a string or array. More... | |
Additional Inherited Members | |
| Public Attributes inherited from ApiFormatBase | |
| $mDisabled = false | |
| $mFormat | |
| $mHelp | |
| $mUnescapeAmps | |
| Public Attributes inherited from ApiBase | |
| string | $mModulePrefix |
| const | ALL_DEFAULT_STRING = '*' |
| const | GET_VALUES_FOR_HELP = 1 |
| getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More... | |
| const | LIMIT_BIG1 = 500 |
| Fast query, standard limit. More... | |
| const | LIMIT_BIG2 = 5000 |
| Fast query, apihighlimits limit. More... | |
| const | LIMIT_SML1 = 50 |
| Slow query, standard limit. More... | |
| const | LIMIT_SML2 = 500 |
| Slow query, apihighlimits limit. More... | |
| const | PARAM_DFLT = 0 |
| (null|boolean|integer|string) Default value of the parameter. More... | |
| const | PARAM_ISMULTI = 1 |
| (boolean) Accept multiple pipe-separated values for this parameter (e.g. More... | |
| const | PARAM_TYPE = 2 |
| (string|string[]) Either an array of allowed value strings, or a string type as described below. More... | |
| const | PARAM_MAX = 3 |
| (integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More... | |
| const | PARAM_MAX2 = 4 |
| (integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. More... | |
| const | PARAM_MIN = 5 |
| (integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More... | |
| const | PARAM_ALLOW_DUPLICATES = 6 |
| (boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? More... | |
| const | PARAM_DEPRECATED = 7 |
| (boolean) Is the parameter deprecated (will show a warning)? More... | |
| const | PARAM_REQUIRED = 8 |
| (boolean) Is the parameter required? More... | |
| const | PARAM_RANGE_ENFORCE = 9 |
| (boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? More... | |
| const | PARAM_HELP_MSG = 10 |
| (string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
| const | PARAM_HELP_MSG_APPEND = 11 |
| ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More... | |
| const | PARAM_HELP_MSG_INFO = 12 |
| (array) Specify additional information tags for the parameter. More... | |
| const | PARAM_VALUE_LINKS = 13 |
| (string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help. More... | |
| const | PARAM_HELP_MSG_PER_VALUE = 14 |
| ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More... | |
| const | PARAM_SUBMODULE_MAP = 15 |
| (string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. More... | |
| const | PARAM_SUBMODULE_PARAM_PREFIX = 16 |
| (string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that). More... | |
| const | PARAM_ALL = 17 |
| (boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value. More... | |
| const | PARAM_EXTRA_NAMESPACES = 18 |
| (int[]) When PARAM_TYPE is 'namespace', include these as additional possible values. More... | |
| const | PARAM_SENSITIVE = 19 |
| (boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field. More... | |
| const | PARAM_DEPRECATED_VALUES = 20 |
| (array) When PARAM_TYPE is an array, this indicates which of the values are deprecated. More... | |
| const | PARAM_ISMULTI_LIMIT1 = 21 |
| (integer) Maximum number of values, for normal users. More... | |
| const | PARAM_ISMULTI_LIMIT2 = 22 |
| (integer) Maximum number of values, for users with the apihighimits right. More... | |
| Protected Member Functions inherited from ApiFormatBase | |
| getExamplesMessages () | |
| Returns usage examples for this module. More... | |
| getIsWrappedHtml () | |
| Returns true when the special wrapped mode is enabled. More... | |
| getParameterFromSettings ( $paramName, $paramSettings, $parseLimit) | |
| Overridden to honor $this->forceDefaultParams(), if applicable @inheritDoc. More... | |
| Protected Member Functions inherited from ApiBase | |
| getWebUITokenSalt (array $params) | |
| Fetch the salt used in the Web UI corresponding to this module. More... | |
| getDB () | |
| Gets a default replica DB connection object. More... | |
| getParameter ( $paramName, $parseLimit=true) | |
| Get a value for the given parameter. More... | |
| getWatchlistValue ( $watchlist, $titleObj, $userOption=null) | |
| Return true if we're to watch the page, false if not, null if no change. More... | |
| handleParamNormalization ( $paramName, $value, $rawValue) | |
| Handle when a parameter was Unicode-normalized. More... | |
| explodeMultiValue ( $value, $limit) | |
| Split a multi-valued parameter string, like explode() More... | |
| parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null) | |
| Return an array of values that were given in a 'a|b|c' notation, after it optionally validates them against the list allowed values. More... | |
| validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false) | |
| Validate the value against the minimum and user/bot maximum limits. More... | |
| validateTimestamp ( $value, $encParamName) | |
| Validate and normalize of parameters of type 'timestamp'. More... | |
| setWatch ( $watch, $titleObj, $userOption=null) | |
| Set a watch (or unwatch) based the based on a watchlist parameter. More... | |
| dieContinueUsageIf ( $condition) | |
| Die with the 'badcontinue' error. More... | |
| getSummaryMessage () | |
| Return the summary message. More... | |
| getExtendedDescription () | |
| Return the extended help text message. More... | |
| getHelpFlags () | |
| Generates the list of flags for the help screen and for action=paraminfo. More... | |
| getModuleSourceInfo () | |
| Returns information about the source of this module, if known. More... | |
| getDescription () | |
| Returns the description string for this module. More... | |
| getParamDescription () | |
| Returns an array of parameter descriptions. More... | |
| getExamples () | |
| Returns usage examples for this module. More... | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. More... | |
| getDescriptionMessage () | |
| Return the description message. More... | |
| Static Protected Member Functions inherited from ApiBase | |
| static | dieDebug ( $method, $message) |
| Internal code errors should be reported with this method. More... | |
| Protected Attributes inherited from ApiFormatBase | |
| $mForceDefaultParams = false | |
Detailed Description
This printer is used to wrap an instance of the Feed class.
Definition at line 31 of file ApiFormatFeedWrapper.php.
Constructor & Destructor Documentation
◆ __construct()
| ApiFormatFeedWrapper::__construct | ( | ApiMain | $main | ) |
Definition at line 33 of file ApiFormatFeedWrapper.php.
Member Function Documentation
◆ canPrintErrors()
| ApiFormatFeedWrapper::canPrintErrors | ( | ) |
ChannelFeed doesn't give us a method to print errors in a friendly manner, so just punt errors to the default printer.
- Returns
- bool
Reimplemented from ApiFormatBase.
Definition at line 67 of file ApiFormatFeedWrapper.php.
◆ execute()
| ApiFormatFeedWrapper::execute | ( | ) |
This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances.
Reimplemented from ApiBase.
Definition at line 98 of file ApiFormatFeedWrapper.php.
References as, ApiBase\dieDebug(), ApiBase\getResult(), and ApiFormatBase\printText().
◆ getMimeType()
| ApiFormatFeedWrapper::getMimeType | ( | ) |
Feed does its own headers.
- Returns
- null
Reimplemented from ApiFormatBase.
Definition at line 58 of file ApiFormatFeedWrapper.php.
◆ initPrinter()
| ApiFormatFeedWrapper::initPrinter | ( | $unused = false | ) |
This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances.
- Parameters
-
bool $unused
Reimplemented from ApiFormatBase.
Definition at line 77 of file ApiFormatFeedWrapper.php.
References ApiBase\dieDebug(), ApiBase\getResult(), and ApiFormatBase\isDisabled().
◆ setResult()
|
static |
Call this method to initialize output data.
See execute()
- Parameters
-
ApiResult $result object $feed An instance of one of the $wgFeedClasses classes array $feedItems Array of FeedItem objects
Definition at line 43 of file ApiFormatFeedWrapper.php.
References ApiResult\NO_VALIDATE.
Referenced by ApiFeedContributions\execute(), ApiFeedRecentChanges\execute(), and ApiFeedWatchlist\execute().
The documentation for this class was generated from the following file:
- includes/api/ApiFormatFeedWrapper.php
