Publish Wiki document using Wiki API.
Use \Project#createTask to register a new Task.
Methods
Close curl connection and clean up
__destruct()
Call Wiki webapi
callApi(string $queryString, array|null $postData = null) : array
Call Wiki webapi edit action
callApiEdit()
Call Wiki webapi login action
callApiLogin(string|null $token = null)
Call Wiki webapi tokens action
callApiTokens()
Validate Wiki webapi response
checkApiResponseResult(string $action, array $response, string $expect = 'Success')
Return prepared data for Wiki webapi edit action
getApiEditData() : array
getApiPassword
getApiPassword() : string
getApiUrl
getApiUrl() : string
getApiUser
getApiUser() : string
getContent
getContent() : string
Returns the textual description of the task
getDescription() : string
inherited
Response
string
The text description of the task
Returns the location within the buildfile this task occurs. Used
by {@link BuildException} to give detailed error messages.
getLocation() : \Location
inherited
Response
\Location
The location object describing the position of this
task within the buildfile.
getMode
getMode() : string
Returns the owning target of this task.
getOwningTarget() : \Target
inherited
Response
\Target
The target object that owns this task
Returns a reference to current project
getProject() : \Project
inherited
Response
\Project
Reference to current porject object
Returns a name
getRegisterSlot(string $slotName)
inherited
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited
Returns the name of task, used only for log messages
getTaskName() : string
inherited
Response
string
Name of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
inherited
Response
string
The type of this task (XML Tag)
getTitle
getTitle() : string
Called by the parser to let the task initialize properly.
init()
inherited
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Logs a message with the given priority.
log(string $msg, integer $level = \Project::MSG_INFO)
inherited
Arguments
$msg
string
The message to be logged.
$level
integer
The message's priority at this message should have
Called by the project to let the task do it's work. This method may be
called more than once, if the task is invoked more than once. For
example, if target1 and target2 both depend on target3, then running
<em>phing target1 target2</em> will run all tasks in target3 twice.
main()
inherited abstract
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
setApiPassword
setApiPassword(string $apiPassword)
setApiUrl
setApiUrl(string $apiUrl)
setApiUser
setApiUser(string $apiUser)
setContent
setContent(string $content)
Sets a textual description of the task
setDescription(string $desc)
inherited
Arguments
$desc
string
The text describing the task
Sets the location within the buildfile this task occurs. Called by
the parser to set location information.
setLocation(\Location $location)
inherited
Arguments
$location
\Location
The location object describing the position of this
task within the buildfile.
setMode
setMode(string $mode)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
inherited
Set POST data for curl call
setPostData(array|null $data = null)
References the project to the current component.
setProject(\Project $project)
inherited
Arguments
$project
\Project
The reference to the current project
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited
Sets the name of this task for log messages
setTaskName(string $name) : string
inherited
Arguments
Response
string
A string representing the name of this task for log
Sets the type of the task. Usually this is the name of the XML tag
setTaskType( $name)
inherited
setTitle
setTitle(string $title)
Validates attributes coming in from XML
validateAttributes()
Properties
Wiki API url
apiUrl : string
Wiki API user name
apiUser : string
Wiki API password
apiPassword : string
Wiki document Id. Document can be identified by title instead.
id : integer
Wiki document title
title : string
Wiki document content
content : string
Publishing mode (append, prepend, overwrite).
mode : string
Publish modes map
modeMap : array
Curl handler
curl : resource
Wiki api edit token
apiEditToken : string
Temporary cookies file
cookiesFile : string
Owning Target object
target : \Target
inherited
Description of the task
description : string
inherited
Internal taskname (req)
taskType : string
inherited
Taskname for logger
taskName : string
inherited
Stored buildfile location
location : \Location
inherited
Wrapper of the task
wrapper : \RuntimeConfigurable
inherited
Holds a reference to the project that a project component
(a task, a target, etc.) belongs to
project : \Project
inherited
var
|
A reference to the current project instance
|
Type(s)
\Project