adding phpdoc comments

[squirrelmail.git] / class / helper / VCard.class.php

<?php

/**
 * vCard.class
 *
 * Copyright (c) 2003-2005 The SquirrelMail Project Team
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * This (will) contain functions needed to vCards.
 *
 * http://www.imc.org/pdi/vcard-21.txt
 *
 * @version $Id$
 * @package squirrelmail
 * @since 1.3.2
 */

/**
 * Unimplemented class that should handle vcards
 * Don't use it unless it is marked as implemented.
 * @package squirrelmail
 */
class VCard {
    /**
     * Create vcard from information stored in array
     * @todo implement vcard creation from array
     * @param array $value_array
     * @return string
     */
    function create_vcard ($value_array) {
        return $vcard;
    }

    /**
     * Read vcard and convert it to array
     * @todo implement vcard parsing
     * @param string $vcard
     * @return array
     */
    function parse_vcard ($vcard) {
        return $array;
    }
}
?>