Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
mahara
mahara
Commits
aadfc702
Commit
aadfc702
authored
Oct 25, 2006
by
Penny Leach
Browse files
added some more phpdocs
parent
8a362549
Changes
1
Hide whitespace changes
Inline
Side-by-side
htdocs/artefact/lib.php
View file @
aadfc702
...
...
@@ -45,12 +45,14 @@ abstract class PluginArtefact extends Plugin {
/**
* This function returns a list of classnames
* of artefact types this plugin provides.
* @abstract
* @return array
*/
public
static
abstract
function
get_artefact_types
();
/**
* This function returns the name of the plugin.
* @abstract
* @return string
*/
public
static
abstract
function
get_plugin_name
();
...
...
@@ -259,12 +261,32 @@ abstract class ArtefactType {
return
false
;
}
/**
* Saves any changes to the database
* @abstract
*/
public
abstract
function
commit
();
/**
* Deletes current instance
* @abstract
*/
public
abstract
function
delete
();
/**
* render instance to given format
* @param int $format format type (constant)
* @param array $options options for format
*/
public
abstract
function
render
(
$format
,
$options
);
/**
* returns path to icon
* can be called statically but not defined so
* so that can be either from instance or static.
* @abstract
* @return string path to icon (relative to docroot)
*/
public
abstract
function
get_icon
();
...
...
@@ -278,8 +300,16 @@ abstract class ArtefactType {
// @todo
}
/**
* returns array of formats can render to (constants)
* @abstract
*/
public
static
abstract
function
get_render_list
(
$format
);
/**
* returns boolean for can render to given format
* @abstract
*/
public
static
abstract
function
can_render_to
(
$format
);
}
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment