<?php
/**
 * Copyright 2006, 2007, 2008, 2009 Eric D. Hough (http://ehough.com)
 * 
 * This file is part of TubePress (http://tubepress.org)
 * 
 * TubePress 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 3 of the License, or
 * (at your option) any later version.
 * 
 * TubePress 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 TubePress.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/**
 * Holds the current options for TubePress. This is the default options,
 * usually in persistent storage somewhere, and custom options parsed
 * from a shortcode
 */
interface org_tubepress_options_manager_OptionsManager
{
   
    /**
     * Gets the value of an option
     *
     * @param string $optionName The name of the option
     * 
     * @return unknown The option value
     */
    public function get($optionName);
    
    /**
     * Enter description here...
     *
     * @param array $customOpts Custom options
     * 
     * @return void
     */
    public function setCustomOptions($customOpts);

    /**
     * Enter description here...
     *
     * @param array $customOpts Custom options
     * 
     * @return void
     */
    public function mergeCustomOptions($customOpts);
    
    /**
     * Enter description here...
     *
     * @param string $newTagString The new shortcode
     * 
     * @return void
     */
    public function setShortcode($newTagString);
    
    /**
     * Enter description here...
     *
     * @return string The full shortcode
     */
    public function getShortcode();
}