- 1 NAME
- 2 DESCRIPTION
- 3 UNDOCUMENTED METHODS
EPrints::DataObj::SneepComment - A single comment.
SneepComment represents a single comment from a user - this may be associated with one of a number of different objetcs.
This class is a subclass of DataObj, with the following metadata fields:
The unique ID of the comment.
The id number of the user to which this comment belongs.
The id number of the object with which this comment is associated.
object_type (text or maybe int or even a namedset?)
The type of the object with which this comment is associated. (EPrint, Documment, User, etc)
The date and time at which the comment was created
The date and time at which the comment was last modified
The text of the comment. Allows a subset of html which can be defined in the sneep.xml config file.
The security type of this comment - who can view it. One of the types of the dataset "security".
$metadata = EPrints::DataObj::SneepComment->get_system_field_info
Return an array describing the system metadata of the SneepComment dataset.
$thing = EPrints::DataObj::SneepComment->new( $session, $commentid )
Return the SneepComment with the given $commentid, or undef if it does not exist.
$comment = EPrints::DataObj::SneepComment->new_from_data( $session, $data )
Construct a new EPrints::DataObj::SneepComment based on the ref to a hash of metadata.
$boolean = $doc->is_public()
True if this document has no security set and is in the live archive.
$url = $doc->get_url( [$file] )
Return the full URL of the document. Overrides the stub in DataObj.
If file is not specified then the "main" file is used.
$success = $doc->commit
Commit any changes that have been made to this object to the database.
(might) Call "set_sneep_comment_automatic_fields" in the ArchiveConfig first to set any automatic fields that may be needed.
$success = $comment->remove
Remove this comment from the database.
$defaults = EPrints::DataObj::EPrint->get_defaults( $session, $data )
Return default values for this object based on the starting data.
$problems = $doc->validate( [$for_archive] )
Return an array of XHTML DOM objects describing validation problems with the entire document, including the metadata and repository config specific requirements.
A reference to an empty array indicates no problems.