IStorableObject.class.php

<?php

namespace wcf\data;

/**
 * Abstract class for all data holder classes.
 *
 * @author  Marcel Werk
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
interface IStorableObject
{
    /**
     * Returns the value of a object data variable with the given name or `null` if no
     * such data variable exists.
     *
     * @return mixed
     */
    public function __get(string $name);

    /**
     * Determines if the object data variable with the given name is set and
     * is not NULL.
     *
     * @return bool
     */
    public function __isset(string $name);

    /**
     * Returns the value of all object data variables.
     *
     * @return mixed[]
     */
    public function getData();

    /**
     * Returns the name of the database table.
     *
     * @return string
     */
    public static function getDatabaseTableName();

    /**
     * Returns the alias of the database table.
     *
     * @return string
     */
    public static function getDatabaseTableAlias();

    /**
     * Returns true if database table index is an identity column.
     *
     * @return bool
     */
    public static function getDatabaseTableIndexIsIdentity();

    /**
     * Returns the name of the database table index.
     *
     * @return string
     */
    public static function getDatabaseTableIndexName();
}