| 1 | <?php
|
|---|
| 2 | /**
|
|---|
| 3 | * Copyright 2006, 2007, 2008, 2009 Eric D. Hough (http://ehough.com)
|
|---|
| 4 | *
|
|---|
| 5 | * This file is part of TubePress (http://tubepress.org)
|
|---|
| 6 | *
|
|---|
| 7 | * TubePress is free software: you can redistribute it and/or modify
|
|---|
| 8 | * it under the terms of the GNU General Public License as published by
|
|---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
|---|
| 10 | * (at your option) any later version.
|
|---|
| 11 | *
|
|---|
| 12 | * TubePress is distributed in the hope that it will be useful,
|
|---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 15 | * GNU General Public License for more details.
|
|---|
| 16 | *
|
|---|
| 17 | * You should have received a copy of the GNU General Public License
|
|---|
| 18 | * along with TubePress. If not, see <http://www.gnu.org/licenses/>.
|
|---|
| 19 | *
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 | /**
|
|---|
| 23 | * Handles persistent storage of TubePress options
|
|---|
| 24 | *
|
|---|
| 25 | */
|
|---|
| 26 | interface org_tubepress_options_storage_StorageManager
|
|---|
| 27 | {
|
|---|
| 28 | /**
|
|---|
| 29 | * Print out debugging info for this
|
|---|
| 30 | * storage manager
|
|---|
| 31 | *
|
|---|
| 32 | * @return void
|
|---|
| 33 | */
|
|---|
| 34 | public function debug();
|
|---|
| 35 |
|
|---|
| 36 | /**
|
|---|
| 37 | * Determines if an option exists
|
|---|
| 38 | *
|
|---|
| 39 | * @param string $optionName The name of the option in question
|
|---|
| 40 | *
|
|---|
| 41 | * @return boolean True if the option exists, false otherwise
|
|---|
| 42 | */
|
|---|
| 43 | public function exists($optionName);
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * Initialize the persistent storage
|
|---|
| 47 | *
|
|---|
| 48 | * @return void
|
|---|
| 49 | */
|
|---|
| 50 |
|
|---|
| 51 | /**
|
|---|
| 52 | * Initializes the storage
|
|---|
| 53 | *
|
|---|
| 54 | * @return void
|
|---|
| 55 | */
|
|---|
| 56 | public function init();
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Retrieve the current value of an option
|
|---|
| 60 | *
|
|---|
| 61 | * @param string $optionName The name of the option
|
|---|
| 62 | *
|
|---|
| 63 | * @return unknown_type The option's value
|
|---|
| 64 | */
|
|---|
| 65 | public function get($optionName);
|
|---|
| 66 |
|
|---|
| 67 | /**
|
|---|
| 68 | * Sets an option value
|
|---|
| 69 | *
|
|---|
| 70 | * @param string $optionName The option name
|
|---|
| 71 | * @param unknown_type $optionValue The option value
|
|---|
| 72 | *
|
|---|
| 73 | * @return void
|
|---|
| 74 | */
|
|---|
| 75 | public function set($optionName, $optionValue);
|
|---|
| 76 | }
|
|---|
