Introduction Installation Compilation Configuration API Reference

 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 

<?php

/**
 * An entry in the database
 */
abstract class QdbEntry
{
    /**
     * Attachs a tag to the entry
     *
     * @example
     * <code>
     * $cluster->blob('Bob the blob')->attachTag('male');
     * </code>
     *
     * @param QdbTag|string $tag The tag to add to the entry, or its alias.
     * @return bool `true` if the tag was added, or `false` it the entry already had this tag.
     * @throws QdbAliasNotFoundException
     * @throws QdbIncompatibleTypeException
     */
    function attachTag($tag);

    /**
     * Gets the alias (i.e. its "key") of the entry.
     *
     * Alias starting with `qdb` are reserved.
     *
     * @return string The alias of the entry.
     */
    function alias();

    /**
     * Enumerates the tags attached to the entry.
     *
     * @example
     * <code>
     * $bobsTags = $cluster->blob('Bob the blob')->getTags();
     * foreach ($bobsTags as $tag) {
     *     echo('Bob has the tag ' . $tag->alias());
     * }
     * </code>
     *
     * @param QdbTag|string $tag The tag to the entry, or it's alias.
     * @return QdbTagCollection A traversable collection of {@link QdbTag}
     * @throws QdbAliasNotFoundException
     */
    function getTags($tag);

    /**
     * Checks if a tag is attached to the entry.
     *
     * @param QdbTag|string $tag The tag to check for, or its alias.
     * @return bool `true` if the entry is tagged with the given tag, `false` otherwise.
     *
     * @example
     * <code>
     * $bob_is_male = $cluster->blob('Bob the Blob')->hasTag('male');
     * // same as $bob_is_male = $cluster->tag('male')->hasEntry('Bob the Blob');
     * </code>
     */
    function hasTag($tag);

    /**
     * Deletes the entry.
     *
     * @example
     * <code>
     * // Bye-bye Bob :-(
     * $cluster->blob('Bob the blob')->remove();
     * </code>
     *
     * @throws QdbAliasNotFoundException
     */
    function remove();

    /**
     * Detaches a tag from the entry.
     *
     * @example
     * <code>
     * $cluster->blob('Bob the blob')->detachTag('stupid name');
     * </code>
     *
     * @param QdbTag|string $tag The tag to the entry, or its alias.
     * @return bool `true` if the tag was added, or `false` it the entry already had this tag.
     * @throws QdbAliasNotFoundException
     * @throws QdbIncompatibleTypeException
     */
    function detachTag($tag);
}
?>