github-migration/what-did-they-say
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

finish inline documentation

Browse Source
This commit is contained in:
John Bintz 2009-08-19 19:58:24 -04:00
parent f1b39cf269
commit ebc04b35d8
2 changed files with 171 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
classes/WhatDidTheySay.php
View File

@ -7,13 +7,19 @@
*/ */
class WhatDidTheySay { class WhatDidTheySay {
var $version = "0.1"; var $version = "0.1";
/**
* Constructor.
*/
function WhatDidTheySay() { function WhatDidTheySay() {
global $wpdb; global $wpdb;
$this->table = $wpdb->prefix . "provided_transcripts"; $this->table = $wpdb->prefix . "provided_transcripts";
} }
/**
* Handle plugin activation.
*/
function install() { function install() {
if (get_option('what-did-they-say-version') !== $this->version) { if (get_option('what-did-they-say-version') !== $this->version) {
$sql = "CREATE TABLE %s ( $sql = "CREATE TABLE %s (
@ -52,6 +58,11 @@ class WhatDidTheySay {
} }
} }
/**
* Get all transcripts for the indicated post.
* @param int $post_id The post ID to search.
* @return array|false The provided transcripts for the post, or false if no transcripts found.
*/
function get_transcripts($post_id) { function get_transcripts($post_id) {
return get_post_meta($post_id, 'provided_transcripts', true); return get_post_meta($post_id, 'provided_transcripts', true);
} }
@ -176,7 +187,11 @@ class WhatDidTheySay {
} }
return false; return false;
} }
/**
* Add a queued transcription to its associated post.
* @param int $transcription_id The transcription ID to approve.
*/
function add_transcription_to_post($transcription_id) { function add_transcription_to_post($transcription_id) {
global $wpdb; global $wpdb;
@ -197,6 +212,12 @@ class WhatDidTheySay {
} }
} }
/**
* Get all the queued transcriptions for a particular user and post.
* @param int $user_id The user ID to search for.
* @param int $post_id The post ID to search for.
* @return array|false The queued transcriptions for this user, or false if they don't have permissions to see queued transcriptions.
*/
function get_queued_transcriptions_for_user_and_post($user_id, $post_id) { function get_queued_transcriptions_for_user_and_post($user_id, $post_id) {
global $wpdb; global $wpdb;
@ -206,7 +227,13 @@ class WhatDidTheySay {
} }
return false; return false;
} }
/**
* Delete a transcript for a particular language from a post.
* @param int $post_id The post to search.
* @param string $language The language code to search for.
* @return boolean True if the transcript was deleted.
*/
function delete_transcript($post_id, $language) { function delete_transcript($post_id, $language) {
if (current_user_can('approve_transcriptions')) { if (current_user_can('approve_transcriptions')) {
$post = get_post($post_id); $post = get_post($post_id);
@ -214,10 +241,16 @@ class WhatDidTheySay {
$current_transcripts = get_post_meta($post_id, "provided_transcripts", true); $current_transcripts = get_post_meta($post_id, "provided_transcripts", true);
unset($current_transcripts[$language]); unset($current_transcripts[$language]);
update_post_meta($post_id, "provided_transcripts", $current_transcripts); update_post_meta($post_id, "provided_transcripts", $current_transcripts);
} return true;
}
} }
return false;
} }
/**
* Get the default transcript language for this blog.
* @return string The language code representing the default language.
*/
function get_default_language() { function get_default_language() {
$language = false; $language = false;
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
@ -227,7 +260,12 @@ class WhatDidTheySay {
} }
return $language; return $language;
} }
/**
* Get the name of a language from the language code.
* @param string $language The language code to search for.
* @return string|false The name of the language as defined in the options, or false if the language was not found.
*/
function get_language_name($language) { function get_language_name($language) {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
@ -237,19 +275,32 @@ class WhatDidTheySay {
return false; return false;
} }
} }
/**
* Get all available languages.
* @return array An array of languages.
*/
function get_languages() { function get_languages() {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
return $options['languages']; return $options['languages'];
} }
/**
* Set whether or not the indicated post can accept new queued transcriptions.
* @param int $post_id The post ID to affect.
* @param boolean $allow True if the post can accept new queued transcriptions.
*/
function set_allow_transcripts_for_post($post_id, $allow = true) { function set_allow_transcripts_for_post($post_id, $allow = true) {
$current_transcripts = get_post_meta($post_id, "provided_transcripts", true); $current_transcripts = get_post_meta($post_id, "provided_transcripts", true);
$current_transcripts['_allow'] = $allow; $current_transcripts['_allow'] = $allow;
update_post_meta($post_id, "provided_transcripts", $current_transcripts); update_post_meta($post_id, "provided_transcripts", $current_transcripts);
} }
/**
* See if the indicated post is accepting new transcripts.
* @return boolean True if the post is acceptin new transcripts.
*/
function get_allow_transcripts_for_post($post_id) { function get_allow_transcripts_for_post($post_id) {
$current_transcripts = get_post_meta($post_id, "provided_transcripts", true); $current_transcripts = get_post_meta($post_id, "provided_transcripts", true);
return $current_transcripts['_allow']; return $current_transcripts['_allow'];

153
classes/WhatDidTheySayAdmin.php
View File

@ -1,5 +1,8 @@
<?php <?php
/**
* Administrative functions for What Did They Say?!?
*/
class WhatDidTheySayAdmin { class WhatDidTheySayAdmin {
var $default_options = array( var $default_options = array(
'languages' => array( 'languages' => array(
@ -23,7 +26,11 @@ class WhatDidTheySayAdmin {
var $language_file; var $language_file;
var $all_languages = array(); var $all_languages = array();
var $notices = array(); var $notices = array();
/**
* Initialize the admin interface.
* @param WhatDidTheySay $what_did_they_say The WhatDidTheySay object to use for all transcript transactions.
*/
function WhatDidTheySayAdmin($what_did_they_say = null) { function WhatDidTheySayAdmin($what_did_they_say = null) {
$this->what_did_they_say = $what_did_they_say; $this->what_did_they_say = $what_did_they_say;
$this->language_file = dirname(__FILE__) . '/../data/lsr-language.txt'; $this->language_file = dirname(__FILE__) . '/../data/lsr-language.txt';
@ -62,18 +69,34 @@ class WhatDidTheySayAdmin {
$this->read_language_file(); $this->read_language_file();
} }
/**
* Handle admin_init action.
*/
function admin_init() { function admin_init() {
wp_enqueue_script('scriptaculous-effects'); wp_enqueue_script('scriptaculous-effects');
} }
/**
* Handle the_media_transcript filter.
* @param string $transcript The transcription text.
* @return string The processed transcription text.
*/
function the_media_transcript($transcript) { function the_media_transcript($transcript) {
return '<div class="transcript">' . $transcript . '</div>'; return '<div class="transcript">' . $transcript . '</div>';
} }
/**
* Handle the_language_name filter.
* @param string $language The name of the language.
* @return string The processed language name.
*/
function the_language_name($language) { function the_language_name($language) {
return '<h3>' . $language . '</h3>'; return '<h3 class="transcript-language">' . $language . '</h3>';
} }
/**
* Handle the wp_footer action.
*/
function wp_footer() { ?> function wp_footer() { ?>
<script type="text/javascript"> <script type="text/javascript">
$$('.transcript-bundle').each(function(d) { $$('.transcript-bundle').each(function(d) {
@ -93,7 +116,11 @@ class WhatDidTheySayAdmin {
<?php } <?php }
/** /**
* user_has_cap filter. * Handle the user_has_cap filter.
* @param array $capabilities The capabilities the user already has.
* @param array $requested_capabilities The capabilities requested by current_user_can.
* @param object $capability_name
* @return array The list of capabilities this user now has.
*/ */
function user_has_cap($capabilities, $requested_capabilities, $capability_name) { function user_has_cap($capabilities, $requested_capabilities, $capability_name) {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
@ -117,7 +144,7 @@ class WhatDidTheySayAdmin {
} }
/** /**
* Show admin notices. * Handle show_admin action.
*/ */
function admin_notices() { function admin_notices() {
if (!empty($this->notices)) { if (!empty($this->notices)) {
@ -129,6 +156,7 @@ class WhatDidTheySayAdmin {
/** /**
* Handle an update to options. * Handle an update to options.
* @param array $info The part of the $_POST array for What Did They Say?!?
*/ */
function handle_update($info) { function handle_update($info) {
foreach (get_class_methods($this) as $method) { foreach (get_class_methods($this) as $method) {
@ -138,14 +166,19 @@ class WhatDidTheySayAdmin {
} }
} }
} }
function handle_update_queue_transcript($queue_transcript_info) { /**
* Handle updates to queued transcripts.
* @param array $info The part of the $_POST array for What Did They Say?!?
* @return string|false A string if a message is to be displayed, or false if no message.
*/
function handle_update_queue_transcript($info) {
$updated = false; $updated = false;
if (current_user_can('submit_transcriptions')) { if (current_user_can('submit_transcriptions')) {
if ($this->what_did_they_say->get_allow_transcripts_for_post($queue_transcript_info['post_id'])) { if ($this->what_did_they_say->get_allow_transcripts_for_post($info['post_id'])) {
switch ($queue_transcript_info['action']) { switch ($info['action']) {
case 'submit_queued_transcript': case 'submit_queued_transcript':
$result = $this->what_did_they_say->add_queued_transcription_to_post($queue_transcript_info['post_id'], $queue_transcript_info); $result = $this->what_did_they_say->add_queued_transcription_to_post($info['post_id'], $info);
if ($result) { if ($result) {
$updated = __('Transcript added to queue.', 'what-did-they-say'); $updated = __('Transcript added to queue.', 'what-did-they-say');
} }
@ -155,27 +188,32 @@ class WhatDidTheySayAdmin {
return $updated; return $updated;
} }
function handle_update_post_transcripts($post_transcript_info) { /**
* Handle updates to post transcripts.
* @param array $info The part of the $_POST array for What Did They Say?!?
* @return string|false A string if a message is to be displayed, or false if no message.
*/
function handle_update_post_transcripts($info) {
$updated = false; $updated = false;
if (current_user_can('approve_transcriptions')) { if (current_user_can('approve_transcriptions')) {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
switch ($post_transcript_info['action']) { switch ($info['action']) {
case "manage_post_transcripts": case "manage_post_transcripts":
foreach ($post_transcript_info['transcripts'] as $language => $transcript) { foreach ($info['transcripts'] as $language => $transcript) {
switch ($language) { switch ($language) {
case "_allow": case "_allow":
$allow = true; $allow = true;
break; break;
default: default:
$this->what_did_they_say->save_transcript($post_transcript_info['post_id'], $language, $transcript); $this->what_did_they_say->save_transcript($info['post_id'], $language, $transcript);
break; break;
} }
} }
$this->what_did_they_say->set_allow_transcripts_for_post($post_transcript_info['post_id'], isset($post_transcript_info['allow_on_post'])); $this->what_did_they_say->set_allow_transcripts_for_post($info['post_id'], isset($info['allow_on_post']));
$queued_transcriptions = $this->what_did_they_say->get_queued_transcriptions_for_post($post_transcript_info['post_id']); $queued_transcriptions = $this->what_did_they_say->get_queued_transcriptions_for_post($info['post_id']);
if (is_array($queued_transcriptions)) { if (is_array($queued_transcriptions)) {
$transcriptions_to_delete = array(); $transcriptions_to_delete = array();
@ -196,28 +234,33 @@ class WhatDidTheySayAdmin {
return $updated; return $updated;
} }
function handle_update_languages($language_info) { /**
* Handle updates to languages.
* @param array $info The part of the $_POST array for What Did They Say?!?
* @return string|false A string if a message is to be displayed, or false if no message.
*/
function handle_update_languages($info) {
$updated = false; $updated = false;
if (current_user_can('change_languages')) { if (current_user_can('change_languages')) {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
switch ($language_info['action']) { switch ($info['action']) {
case "delete": case "delete":
$updated = sprintf(__('%s deleted.', 'what-did-they-say'), $options['languages'][$language_info['code']]['name']); $updated = sprintf(__('%s deleted.', 'what-did-they-say'), $options['languages'][$info['code']]['name']);
unset($options['languages'][$language_info['code']]); unset($options['languages'][$info['code']]);
break; break;
case "add": case "add":
$this->read_language_file(); $this->read_language_file();
if (isset($this->all_languages[$language_info['code']])) { if (isset($this->all_languages[$info['code']])) {
$options['languages'][$language_info['code']] = array('name' => $this->all_languages[$language_info['code']]); $options['languages'][$info['code']] = array('name' => $this->all_languages[$info['code']]);
$updated = sprintf(__('%s added.', 'what-did-they-say'), $this->all_languages[$language_info['code']]); $updated = sprintf(__('%s added.', 'what-did-they-say'), $this->all_languages[$info['code']]);
} }
break; break;
case "default": case "default":
if (isset($options['languages'][$language_info['code']])) { if (isset($options['languages'][$info['code']])) {
foreach ($options['languages'] as $code => $info) { foreach ($options['languages'] as $code => $lang_info) {
if ($code == $language_info['code']) { if ($code == $info['code']) {
$options['languages'][$code]['default'] = true; $options['languages'][$code]['default'] = true;
$updated = sprintf(__('%s set as default.', 'what-did-they-say'), $info['name']); $updated = sprintf(__('%s set as default.', 'what-did-they-say'), $lang_info['name']);
} else { } else {
unset($options['languages'][$code]['default']); unset($options['languages'][$code]['default']);
} }
@ -225,10 +268,10 @@ class WhatDidTheySayAdmin {
} }
break; break;
case "rename": case "rename":
if (isset($options['languages'][$language_info['code']])) { if (isset($options['languages'][$info['code']])) {
if (!empty($language_info['name'])) { if (!empty($info['name'])) {
$updated = sprintf(__('%1$s renamed to %2$s.', 'what-did-they-say'), $options['languages'][$language_info['code']]['name'], $language_info['name']); $updated = sprintf(__('%1$s renamed to %2$s.', 'what-did-they-say'), $options['languages'][$info['code']]['name'], $info['name']);
$options['languages'][$language_info['code']]['name'] = $language_info['name']; $options['languages'][$info['code']]['name'] = $info['name'];
} }
} }
break; break;
@ -237,20 +280,25 @@ class WhatDidTheySayAdmin {
ksort($options['languages']); ksort($options['languages']);
update_option('what-did-they-say-options', $options); update_option('what-did-they-say-options', $options);
} }
} }
return $updated; return $updated;
} }
function handle_update_capabilities($capabilities_info) { /**
* Handle updates to user capabilities.
* @param array $info The part of the $_POST array for What Did They Say?!?
* @return string|false A string if a message is to be displayed, or false if no message.
*/
function handle_update_capabilities($info) {
$updated = false; $updated = false;
if (current_user_can('edit_users')) { if (current_user_can('edit_users')) {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
switch ($capabilities_info['action']) { switch ($info['action']) {
case "capabilities": case "capabilities":
if (isset($capabilities_info['capabilities'])) { if (isset($info['capabilities'])) {
foreach (array_keys($this->default_options['capabilities']) as $capability) { foreach (array_keys($this->default_options['capabilities']) as $capability) {
if (isset($capabilities_info['capabilities'][$capability])) { if (isset($info['capabilities'][$capability])) {
$options['capabilities'][$capability] = $capabilities_info['capabilities'][$capability]; $options['capabilities'][$capability] = $info['capabilities'][$capability];
} }
} }
$updated = __('User capabilities updated', 'what-did-they-say'); $updated = __('User capabilities updated', 'what-did-they-say');
@ -264,6 +312,13 @@ class WhatDidTheySayAdmin {
return $updated; return $updated;
} }
/**
* Read a data file containing all the known languages on Earth.
* The data originally came from http://www.langtag.net/, specifically http://www.langtag.net/registries/lsr-language.txt.
* The data file format is tab-delimited, with the following fields:
* language_code date_added name_of_language additional_information
* @return array The list of all known languages on Earth as code => language.
*/
function read_language_file() { function read_language_file() {
if (file_exists($this->language_file)) { if (file_exists($this->language_file)) {
foreach (file($this->language_file, FILE_IGNORE_NEW_LINES) as $language) { foreach (file($this->language_file, FILE_IGNORE_NEW_LINES) as $language) {
@ -274,6 +329,9 @@ class WhatDidTheySayAdmin {
return $this->all_languages; return $this->all_languages;
} }
/**
* Handle plugin installation.
*/
function install() { function install() {
$this->read_language_file(); $this->read_language_file();
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
@ -283,6 +341,10 @@ class WhatDidTheySayAdmin {
} }
} }
/**
* From $this->default_options, fill in the language details from the language file.
* @return array The language info will all details filled in.
*/
function build_default_languages() { function build_default_languages() {
$full_default_language_info = array(); $full_default_language_info = array();
foreach ($this->default_options['languages'] as $info) { foreach ($this->default_options['languages'] as $info) {
@ -304,6 +366,9 @@ class WhatDidTheySayAdmin {
return $full_default_language_info; return $full_default_language_info;
} }
/**
* Handle admin_menu action.
*/
function admin_menu() { function admin_menu() {
if (current_user_can('edit_users')) { if (current_user_can('edit_users')) {
add_options_page( add_options_page(
@ -326,13 +391,19 @@ class WhatDidTheySayAdmin {
); );
} }
} }
/**
* Show the admin page.
*/
function manage_admin() { function manage_admin() {
$options = get_option('what-did-they-say-options'); $options = get_option('what-did-they-say-options');
$nonce = wp_create_nonce('what-did-they-say'); $nonce = wp_create_nonce('what-did-they-say');
include(dirname(__FILE__) . '/admin.inc'); include(dirname(__FILE__) . '/admin.inc');
} }
/**
* Show the Manage Transcriptions meta box.
*/
function manage_transcriptions_meta_box() { function manage_transcriptions_meta_box() {
global $post; global $post;