<?php
/*
 * $RCSfile: GalleryComment.class,v $
 *
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2005 Bharat Mediratta
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
 */
/**
 * @package Comment
 * @version $Revision: 1.25 $ $Date: 2005/08/23 03:49:02 $
 * @author Bharat Mediratta <bharat@menalto.com>
 */

/**
 * Load the parent class
 */
GalleryCoreApi::relativeRequireOnce('modules/core/classes/GalleryChildEntity.class');

/**
 * A GalleryEntity for comments.
 *
 * GalleryComments are basically just structured text objects.
 *
 * @g2 <class-name>GalleryComment</class-name>
 * @g2 <parent-class-name>GalleryChildEntity</parent-class-name>
 * @g2 <schema>
 * @g2   <schema-major>1</schema-major>
 * @g2   <schema-minor>0</schema-minor>
 * @g2 </schema>
 * @g2 <requires-id/>
 *
 * @package Comment
 * @subpackage Classes
 */
class GalleryComment_core extends GalleryChildEntity {

    /*
     * ****************************************
     *                 Members
     * ****************************************
     */

    /**
     * Id of the commenter
     *
     * @g2 <member>
     * @g2   <member-name>commenterId</member-name>
     * @g2   <member-type>INTEGER</member-type>
     * @g2   <member-size>LARGE</member-size>
     * @g2   <required/>
     * @g2 </member>
     *
     * @var $_commenterId
     * @access private
     */
    var $_commenterId;

    /**
     * Commenter's host name or address
     *
     * @g2 <member>
     * @g2   <member-name>host</member-name>
     * @g2   <member-type>STRING</member-type>
     * @g2   <member-size>MEDIUM</member-size>
     * @g2   <required/>
     * @g2 </member>
     *
     * @var $_host
     * @access private
     */
    var $_host;

    /**
     * Subject of the comment
     *
     * @g2 <member>
     * @g2   <member-name>subject</member-name>
     * @g2   <member-type>STRING</member-type>
     * @g2   <member-size>MEDIUM</member-size>
     * @g2 </member>
     *
     * @var $_subject
     * @access private
     */
    var $_subject;

    /**
     * Text of the comment
     *
     * @g2 <member>
     * @g2   <member-name>comment</member-name>
     * @g2   <member-type>TEXT</member-type>
     * @g2 </member>
     *
     * @var $_comment
     * @access private
     */
    var $_comment;

    /**
     * Date of the comment
     *
     * @g2 <member>
     * @g2   <member-name>date</member-name>
     * @g2   <member-type>INTEGER</member-type>
     * @g2   <indexed/>
     * @g2   <required/>
     * @g2 </member>
     *
     * @var $_date
     * @access private
     */
    var $_date;

    /*
     * ****************************************
     *                 Methods
     * ****************************************
     */

}

include(dirname(__FILE__) . '/interfaces/GalleryComment.inc');
?>
