diff --git a/bin/arc_tool.php b/bin/arc_tool.php index acee2d303..bde6cfa33 100755 --- a/bin/arc_tool.php +++ b/bin/arc_tool.php @@ -88,7 +88,7 @@ mb_regex_encoding("UTF-8"); * * @author Chris Pollett (non-yioop archive code derived from earlier * stuff by Shawn Tice) - * @package seek_quarry + * @package seek_quarry\bin */ class ArcTool implements CrawlConstants { @@ -346,6 +346,8 @@ class ArcTool implements CrawlConstants * in the archive supplied in $archive_path as well as an overall count * * @param string $archive_path patch of archive to count + * @param bool $set_count flag that controls whether after computing + * the count to write it back into the archive */ function outputCountIndexArchive($archive_path, $set_count = false) { diff --git a/bin/classifier_tool.php b/bin/classifier_tool.php index 4395b5c6b..4e8996a90 100755 --- a/bin/classifier_tool.php +++ b/bin/classifier_tool.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -137,7 +135,7 @@ mb_regex_encoding("UTF-8"); * * a labeled training set is available. * @author Shawn Tice - * @package seek_quarry + * @package seek_quarry\bin */ class ClassifierTool { diff --git a/bin/classifier_trainer.php b/bin/classifier_trainer.php index 6966c17c6..bccb82e30 100755 --- a/bin/classifier_trainer.php +++ b/bin/classifier_trainer.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -81,7 +79,7 @@ ini_set("memory_limit", "500M"); * $ php bin/classifier_trainer.php terminal LABEL * * @author Shawn Tice - * @package seek_quarry + * @package seek_quarry\bin */ class ClassifierTrainer { diff --git a/bin/code_tool.php b/bin/code_tool.php index e89725727..8a9cfa6f9 100755 --- a/bin/code_tool.php +++ b/bin/code_tool.php @@ -27,8 +27,6 @@ * replaces. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -115,7 +113,6 @@ php code_tool.php search path pattern EOD; } - /** * Used to clean trailing whitespace from files in a folder or just from * a file given in the command line @@ -127,7 +124,6 @@ EOD; function clean($args) { global $num_spaces_tab; - $no_instructions = false; if(isset($args[0])) { $path = realpath($args[0]); @@ -148,7 +144,6 @@ function clean($args) function copyright($args) { $no_instructions = false; - if(isset($args[0])) { $path = realpath($args[0]); $year = date("Y"); diff --git a/bin/fetcher.php b/bin/fetcher.php index 66bae8c4a..087f8100c 100755 --- a/bin/fetcher.php +++ b/bin/fetcher.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -140,7 +138,7 @@ mb_regex_encoding("UTF-8"); * be found in the documentation for {@link buildMiniInvertedIndex()} * * @author Chris Pollett - * @package seek_quarry + * @package seek_quarry\bin * @see buildMiniInvertedIndex() */ class Fetcher implements CrawlConstants diff --git a/bin/media_updater.php b/bin/media_updater.php index f2ed6aa79..dd763630e 100644 --- a/bin/media_updater.php +++ b/bin/media_updater.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -105,7 +103,7 @@ if (function_exists('lcfirst') === false) { * for updating. Makes use of the web-apps code. * * @author Chris Pollett - * @package seek_quarry + * @package seek_quarry\bin */ class MediaUpdater implements CrawlConstants { diff --git a/bin/mirror.php b/bin/mirror.php index 3c4af7468..daf3bce8d 100644 --- a/bin/mirror.php +++ b/bin/mirror.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -74,8 +72,7 @@ mb_regex_encoding("UTF-8"); * download them. * * @author Chris Pollett - * @package seek_quarry - * @see buildMiniInvertedIndex() + * @package seek_quarry\bin */ class Mirror implements CrawlConstants { diff --git a/bin/query_tool.php b/bin/query_tool.php index 7815bba17..4a7b2c361 100755 --- a/bin/query_tool.php +++ b/bin/query_tool.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -76,7 +74,7 @@ mb_regex_encoding("UTF-8"); * this tool. * * @author Chris Pollett - * @package seek_quarry + * @package seek_quarry\bin */ class QueryTool implements CrawlConstants { diff --git a/bin/queue_server.php b/bin/queue_server.php index f826dc002..f13ea9a08 100755 --- a/bin/queue_server.php +++ b/bin/queue_server.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -112,7 +110,7 @@ if(USE_MEMCACHE) { * that is used by the search front end. * * @author Chris Pollett - * @package seek_quarry + * @package seek_quarry\bin */ class QueueServer implements CrawlConstants, Join { diff --git a/blog.php b/blog.php index 0b2c1c1b5..72c5e17a7 100755 --- a/blog.php +++ b/blog.php @@ -26,8 +26,6 @@ * the SeekQuarry/Yioop Search engine * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage static * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/bot.php b/bot.php index f02f8cbd0..a56771395 100755 --- a/bot.php +++ b/bot.php @@ -26,8 +26,6 @@ * the SeekQuarry/Yioop Search engine * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage static * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/configs/config.php b/configs/config.php index 746618ca0..28731b750 100755 --- a/configs/config.php +++ b/configs/config.php @@ -25,8 +25,6 @@ * Used to set the configuration settings of the SeekQuarry project. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage configs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/configs/configure_tool.php b/configs/configure_tool.php index 1496c5be7..baeafd52d 100644 --- a/configs/configure_tool.php +++ b/configs/configure_tool.php @@ -26,8 +26,6 @@ * command-line for Yioop. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage configs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -59,6 +57,7 @@ require_once(BASE_DIR."/controllers/admin_controller.php"); /** * Provides a command-line interface way to configure a Yioop Instance. * Unlike the web interface this interface is English-only. + * @package seek_quarry\configs */ class ConfigureTool { @@ -571,4 +570,4 @@ class ConfigureTool $configure_tool = new ConfigureTool(); $configure_tool->loop(); -?> \ No newline at end of file +?> diff --git a/configs/createdb.php b/configs/createdb.php index 9143a2808..1bc27dfa8 100755 --- a/configs/createdb.php +++ b/configs/createdb.php @@ -27,8 +27,6 @@ * minimal sqlite database so this script is not strictly needed. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage configs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/configs/export_public_help_db.php b/configs/export_public_help_db.php index 1edef739d..bebedbb49 100644 --- a/configs/export_public_help_db.php +++ b/configs/export_public_help_db.php @@ -27,8 +27,6 @@ * used by createdb.php when creating a fresh version of the Yioop database. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage configs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -67,9 +65,10 @@ $sql = "SELECT GPH.TITLE AS TITLE, GPH.PAGE AS PAGE, ". " GPH.PUBDATE < GP.PUBDATE) ORDER BY GPH.LOCALE_TAG, GPH.TITLE"; $result = $db->execute($sql); $out_file = "public_help_pages.php"; -$out = "<"."?php\n"; -$out .= "// This file should be generated using export_public_help_db.php\n"; -$out .= "//\n// Default Public Wiki Pages\n//\n"; +$out = "<"."?php\n/**\n"; +$out .= " *\n * Default Public Wiki Pages\n *\n"; +$out .= " * This file should be generated using export_public_help_db.php\n"; +$out .= " */\n"; $out .= '$public_pages = array();'."\n"; if($result) { while($row = $db->fetchArray($result)) { diff --git a/configs/public_help_pages.php b/configs/public_help_pages.php index af22e35e1..7227393d5 100644 --- a/configs/public_help_pages.php +++ b/configs/public_help_pages.php @@ -1,23 +1,25 @@ <?php -// This file should be generated using export_public_help_db.php -// -// Default Public Wiki Pages -// +/** + * + * Default Public Wiki Pages + * + * This file should be generated using export_public_help_db.php + */ $public_pages = array(); -$public_pages["en-US"]["404"] = <<< EOD +$public_pages["en-US"]["404"] = <<< 'EOD' title=Page Not Found description=The page you requested cannot be found on our server END_HEAD_VARS ==The page you requested cannot be found.== EOD; -$public_pages["en-US"]["409"] = <<< EOD +$public_pages["en-US"]["409"] = <<< 'EOD' title=Conflict description=Your request would result in an edit conflict. END_HEAD_VARS ==Your request would result in an edit conflict, so will not be processed.== EOD; -$public_pages["en-US"]["Main"] = <<< EOD +$public_pages["en-US"]["Main"] = <<< 'EOD' page_type=standard page_alias= @@ -40,7 +42,7 @@ page_footer= END_HEAD_VARS EOD; -$public_pages["en-US"]["Syntax"] = <<< EOD +$public_pages["en-US"]["Syntax"] = <<< 'EOD' page_type=standard page_alias= @@ -430,7 +432,7 @@ displays as a single page with all slides visible. Collapsing the Activity panel the slides as a typical slide presentation using the [[www.w3.org/Talks/Tools/Slidy2/Overview.html|Slidy]] javascript. EOD; -$public_pages["en-US"]["bot"] = <<< EOD +$public_pages["en-US"]["bot"] = <<< 'EOD' title=Bot description=Describes the web crawler used with this @@ -440,7 +442,7 @@ END_HEAD_VARS Please Describe Your Robot EOD; -$public_pages["en-US"]["captcha_time_out"] = <<< EOD +$public_pages["en-US"]["captcha_time_out"] = <<< 'EOD' title=Captcha/Recover Time Out END_HEAD_VARS ==Account Timeout== @@ -449,7 +451,7 @@ A large number of captcha refreshes or recover password requests have been made from this IP address. Please wait until %s to try again. EOD; -$public_pages["en-US"]["privacy"] = <<< EOD +$public_pages["en-US"]["privacy"] = <<< 'EOD' title=Privacy Policy description=Describes what information this site collects and retains about @@ -457,7 +459,7 @@ users and how it uses that information END_HEAD_VARS ==We are concerned with your privacy== EOD; -$public_pages["en-US"]["register_time_out"] = <<< EOD +$public_pages["en-US"]["register_time_out"] = <<< 'EOD' title=Create/Recover Account END_HEAD_VARS @@ -468,10 +470,10 @@ A number of incorrect captcha responses or recover password requests have been made from this IP address. Please wait until %s to access this site. EOD; -$public_pages["en-US"]["suggest_day_exceeded"] = <<< EOD +$public_pages["en-US"]["suggest_day_exceeded"] = <<< 'EOD' EOD; -$public_pages["en-US"]["terms"] = <<< EOD +$public_pages["en-US"]["terms"] = <<< 'EOD' =Terms of Service= Please write the terms for the services provided by this website. @@ -1837,4 +1839,4 @@ of Yioop and set the Work Directory path to the value of your pre-upgrade versio reason the Work Directory should not be a subfolder of the Yioop code folder. EOD; -?> +?> \ No newline at end of file diff --git a/configs/token_tool.php b/configs/token_tool.php index 13e1fdda2..c00f79023 100644 --- a/configs/token_tool.php +++ b/configs/token_tool.php @@ -30,7 +30,6 @@ * * @author Ravi Dhillon ravi.dhillon@yahoo.com, Chris Pollett (modified for n * ngrams) - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/controllers/admin_controller.php b/controllers/admin_controller.php index 6a4d72718..5b72dc8ba 100755 --- a/controllers/admin_controller.php +++ b/controllers/admin_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -49,8 +47,7 @@ require_once BASE_DIR."/lib/crawl_daemon.php"; * for users, roles, locale, and crawls * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class AdminController extends Controller implements CrawlConstants { diff --git a/controllers/api_controller.php b/controllers/api_controller.php index 8fb7875de..f2d653eb4 100644 --- a/controllers/api_controller.php +++ b/controllers/api_controller.php @@ -1,6 +1,5 @@ <?php - -/* +/** * SeekQuarry/Yioop -- * Open Source Pure PHP Search Engine, Crawler, and Indexer * @@ -24,38 +23,25 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 * @filesource */ - -/** - * Description of ApiController - * - * @author epinapala - */ -if (!defined('BASE_DIR')) { - echo "BAD REQUEST"; - exit(); -} +if (!defined('BASE_DIR')) { echo "BAD REQUEST"; exit(); } /** Load base controller class if needed */ require_once BASE_DIR . "/controllers/controller.php"; /** Loads common constants for web crawling */ require_once BASE_DIR . "/lib/crawl_constants.php"; /** For Wiki Parsing */ require_once BASE_DIR . "/lib/wiki_parser.php"; - /** * Controller used to handle user group activities outside of * the admin panel setting. This either could be because the admin panel * is "collapsed" or because the request concerns a wiki page. * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class ApiController extends Controller implements CrawlConstants { diff --git a/controllers/archive_controller.php b/controllers/archive_controller.php index b253330e3..7ca979a79 100755 --- a/controllers/archive_controller.php +++ b/controllers/archive_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * this controller is used to handle access to these web page caches * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class ArchiveController extends Controller implements CrawlConstants { diff --git a/controllers/classifier_controller.php b/controllers/classifier_controller.php index 96800885a..d5d26def3 100644 --- a/controllers/classifier_controller.php +++ b/controllers/classifier_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/archive_bundle_iterators/". * the other asynchronous requests issued by the JavaScript on the page. * * @author Shawn Tice - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class ClassifierController extends Controller implements CrawlConstants { diff --git a/controllers/components/accountaccess_component.php b/controllers/components/accountaccess_component.php index debf54a07..3c717e282 100644 --- a/controllers/components/accountaccess_component.php +++ b/controllers/components/accountaccess_component.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage component * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * AdminController * * @author Chris Pollett - * @package seek_quarry - * @subpackage component + * @package seek_quarry\controller\component */ class AccountaccessComponent extends Component { diff --git a/controllers/components/component.php b/controllers/components/component.php index 9c93f40f9..66d13791f 100644 --- a/controllers/components/component.php +++ b/controllers/components/component.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage component * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * activities and their auxiliary methods that can be used by a controller * * @author Chris Pollett - * @package seek_quarry - * @subpackage component + * @package seek_quarry\controller\component */ class Component { @@ -62,4 +59,4 @@ class Component { $this->parent = $parent_controller; } -} \ No newline at end of file +} diff --git a/controllers/components/crawl_component.php b/controllers/components/crawl_component.php index dcd435a17..0f0f1a90d 100644 --- a/controllers/components/crawl_component.php +++ b/controllers/components/crawl_component.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage component * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * to configuring and performing a web or archive crawl * * @author Chris Pollett - * @package seek_quarry - * @subpackage component + * @package seek_quarry\controller\component */ class CrawlComponent extends Component implements CrawlConstants { diff --git a/controllers/components/social_component.php b/controllers/components/social_component.php index c937cf308..b513b93f3 100644 --- a/controllers/components/social_component.php +++ b/controllers/components/social_component.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage component * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/mail_server.php"; * blogs (and blog entries), static web pages, and crawl mixes. * * @author Chris Pollett - * @package seek_quarry - * @subpackage component + * @package seek_quarry\controller\component */ class SocialComponent extends Component implements CrawlConstants { @@ -524,7 +521,7 @@ class SocialComponent extends Component implements CrawlConstants * membership in a group if the group is By Request or Public * Request * - * @param array &$data field variables to be drawn to view, + * @param array& $data field variables to be drawn to view, * we modify the SCRIPT component of this with a message * regarding success of not of add attempt. * @param int $add_id group id to be added @@ -2036,16 +2033,16 @@ EOD; return $data; } /** - * The controller used to display a wiki page might vary (could be - * admin, group or static). Links within a wiki page need to be updated - * to reflect which controller is being used. This method does the - * update. + * The controller used to display a wiki page might vary (could be + * admin, group or static). Links within a wiki page need to be updated + * to reflect which controller is being used. This method does the + * update. * - * @param int $group_id id of wiki page the passed page belongs to - * @param array $data fields etc which will be sent to the view - * @param string $pre_page a wiki page where links,etc have not yet + * @param int $group_id id of wiki page the passed page belongs to + * @param array $data fields etc which will be sent to the view + * @param string $pre_page a wiki page where links,etc have not yet * had dynamic substitutions applied - * @return string page after subustitutions + * @return string page after subustitutions */ function dynamicSubstitutions($group_id, $data, $pre_page) { diff --git a/controllers/components/system_component.php b/controllers/components/system_component.php index addcf7711..c30b57b8c 100755 --- a/controllers/components/system_component.php +++ b/controllers/components/system_component.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage component * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and which processes they run. * * @author Chris Pollett - * @package seek_quarry - * @subpackage component + * @package seek_quarry\controller\component */ class SystemComponent extends Component { diff --git a/controllers/controller.php b/controllers/controller.php index d334f6673..dc0013af6 100755 --- a/controllers/controller.php +++ b/controllers/controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -56,8 +54,7 @@ require_once BASE_DIR."/views/view.php"; * the SeekQuarry site. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ abstract class Controller { @@ -262,14 +259,13 @@ abstract class Controller $this->view($view)->render($data); } /** - * Does a 301 redirect to the given location, sets a session variable - * to display a message when get there. + * Does a 301 redirect to the given location, sets a session variable + * to display a message when get there. * - * @param string $message message to write - * @param string $copy_field $_REQUEST fields to copy for redirect + * @param string $message message to write + * @param string $copy_fields $_REQUEST fields to copy for redirect */ - function redirectWithMessage($message, $copy_fields = false, $location = - NULL) + function redirectWithMessage($message, $copy_fields = false) { $default_fields = array("just_thread", "just_group_id", "just_user_id", "group_id", "user_id", "role_id", "limit", "num"); @@ -517,7 +513,7 @@ abstract class Controller * * @param string $token_name name of a $_REQUEST field used to hold a * CSRF_TOKEN - * @param string name of current action to check for conflicts + * @param string $action name of current action to check for conflicts * @return bool whether a conflicting action has occurred. */ function checkCSRFTime($token_name, $action = "") @@ -763,19 +759,19 @@ abstract class Controller return true; } /** - * Used to parse head meta variables out of a data string provided either - * from a wiki page or a static page. Meta data is stored in lines - * before the first occurrence of END_HEAD_VARS. Head variables - * are name=value pairs. An example of head - * variable might be: - * title = This web page's title - * Anything after a semi-colon on a line in the head section is treated as - * a comment + * Used to parse head meta variables out of a data string provided either + * from a wiki page or a static page. Meta data is stored in lines + * before the first occurrence of END_HEAD_VARS. Head variables + * are name=value pairs. An example of head + * variable might be: + * title = This web page's title + * Anything after a semi-colon on a line in the head section is treated as + * a comment * - * @param object $view View on which page data will be rendered - * @param string $page_name a string name/id to associate with page. For - * example, might have 404 for a page about 404 errors - * @param string $page_data this is the actual content of a wiki or + * @param object $view View on which page data will be rendered + * @param string $page_name a string name/id to associate with page. For + * example, might have 404 for a page about 404 errors + * @param string $page_data this is the actual content of a wiki or * static page */ function parsePageHeadVars($view, $page_name, $page_data) @@ -806,7 +802,9 @@ abstract class Controller * this function can be used to initialize the field variables used * to write the appropriate Javascripts * - * @param array &$data data to be used in drawing the view + * @param array& $data data to be used in drawing the view + * @param bool $ads_off whether or not ads are turned off so that this + * method should do nothing */ function initializeAdFields(&$data, $ads_off = false) { diff --git a/controllers/crawl_controller.php b/controllers/crawl_controller.php index 25611c6cd..289d89326 100644 --- a/controllers/crawl_controller.php +++ b/controllers/crawl_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * through a result web page back to the name_server. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class CrawlController extends Controller implements CrawlConstants { diff --git a/controllers/fetch_controller.php b/controllers/fetch_controller.php index 1a7d070de..45dd2c725 100755 --- a/controllers/fetch_controller.php +++ b/controllers/fetch_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -51,8 +49,7 @@ foreach(glob(BASE_DIR."/lib/archive_bundle_iterators/*_bundle_iterator.php") * This class can also be used by a fetcher to get status information. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class FetchController extends Controller implements CrawlConstants { diff --git a/controllers/group_controller.php b/controllers/group_controller.php index 62e708ece..ebe96780e 100644 --- a/controllers/group_controller.php +++ b/controllers/group_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/wiki_parser.php"; * is "collapsed" or because the request concerns a wiki page. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class GroupController extends Controller implements CrawlConstants { diff --git a/controllers/machine_controller.php b/controllers/machine_controller.php index 62032891d..eb05d4414 100644 --- a/controllers/machine_controller.php +++ b/controllers/machine_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/crawl_daemon.php"; * fetchers/queue_server as well as get status on the active fetchers * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class MachineController extends Controller implements CrawlConstants { diff --git a/controllers/register_controller.php b/controllers/register_controller.php index 2fe308421..609ae4d5b 100755 --- a/controllers/register_controller.php +++ b/controllers/register_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/mail_server.php"; * the Yioop website. Also handles data for suggest a url * * @author Mallika Perepa (Creator), Chris Pollett (extensive rewrite) - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class RegisterController extends Controller implements CrawlConstants { @@ -1228,4 +1225,4 @@ class RegisterController extends Controller implements CrawlConstants return false; } } -?> \ No newline at end of file +?> diff --git a/controllers/resource_controller.php b/controllers/resource_controller.php index 6929e902f..d1cba18b7 100644 --- a/controllers/resource_controller.php +++ b/controllers/resource_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * Used to serve resources, css, or scripts such as images from APP_DIR * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class ResourceController extends Controller implements CrawlConstants { @@ -176,8 +173,13 @@ class ResourceController extends Controller implements CrawlConstants } /** * Code to handle HTTP range requests of resources. This allows - * HTTP pseudo streaming of video. This code was inspired by: + * HTTP pseudo-streaming of video. This code was inspired by: * http://www.tuxxin.com/php-mp4-streaming/ + * + * @param string $file Name of file to serve range request for + * @param int $size size of the file in bytes + * @param int $start starting byte location want to serve + * @param int $end ending byte location want ot serve */ function serveRangeRequest($file, $size, $start, $end) { diff --git a/controllers/search_controller.php b/controllers/search_controller.php index 1c6af50c4..45ad8113d 100755 --- a/controllers/search_controller.php +++ b/controllers/search_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -49,8 +47,7 @@ require_once BASE_DIR."/lib/locale_functions.php"; * search results. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class SearchController extends Controller implements CrawlConstants { diff --git a/controllers/settings_controller.php b/controllers/settings_controller.php index ee559ea2a..3a193bf1c 100755 --- a/controllers/settings_controller.php +++ b/controllers/settings_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/controllers/controller.php"; * search results. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class SettingsController extends Controller { diff --git a/controllers/static_controller.php b/controllers/static_controller.php index 4c9da9a7a..b6562fbc9 100644 --- a/controllers/static_controller.php +++ b/controllers/static_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ require_once BASE_DIR."/controllers/controller.php"; * PUBLIC_GROUP_ID pages more like static forward facing pages. * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class StaticController extends Controller { diff --git a/controllers/statistics_controller.php b/controllers/statistics_controller.php index f6edebb7b..b73cf388a 100644 --- a/controllers/statistics_controller.php +++ b/controllers/statistics_controller.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage controller * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -46,8 +44,7 @@ define("NO_FEEDS", true); * distribution, download time distribution, etc * * @author Chris Pollett - * @package seek_quarry - * @subpackage controller + * @package seek_quarry\controller */ class StatisticsController extends Controller implements CrawlConstants { diff --git a/css/editor.css b/css/editor.css index db6752f26..a39f57399 100755 --- a/css/editor.css +++ b/css/editor.css @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage stylesheet + * @package seek_quarry\stylesheet * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/css/search.css b/css/search.css index d221dccdd..c9b761a8b 100755 --- a/css/search.css +++ b/css/search.css @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage stylesheet + * @package seek_quarry\stylesheet * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/error.php b/error.php index 55e88ee31..b8d0a5afb 100755 --- a/error.php +++ b/error.php @@ -26,8 +26,6 @@ * the SeekQuarry/Yioop Search engine * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage static * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/examples/search_api.php b/examples/search_api.php index c676b1b6d..ffbce2477 100644 --- a/examples/search_api.php +++ b/examples/search_api.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage examples * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/index.php b/index.php index ea025486f..71bae0656 100755 --- a/index.php +++ b/index.php @@ -28,7 +28,6 @@ * communication during crawling * * @author Chris Pollett chris@pollett.org - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/lib/analytics_manager.php b/lib/analytics_manager.php index fec82dec3..e77916d82 100644 --- a/lib/analytics_manager.php +++ b/lib/analytics_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * * @author Chris Pollett * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class AnalyticsManager { diff --git a/lib/archive_bundle_iterators/arc_archive_bundle_iterator.php b/lib/archive_bundle_iterators/arc_archive_bundle_iterator.php index c16143210..034eb2d53 100644 --- a/lib/archive_bundle_iterators/arc_archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/arc_archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR. * for the purpose making an index of these records * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class ArcArchiveBundleIterator extends TextArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/archive_bundle_iterator.php b/lib/archive_bundle_iterators/archive_bundle_iterator.php index 60f2c3026..a83b51532 100644 --- a/lib/archive_bundle_iterators/archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ abstract class ArchiveBundleIterator implements CrawlConstants diff --git a/lib/archive_bundle_iterators/database_bundle_iterator.php b/lib/archive_bundle_iterators/database_bundle_iterator.php index c27bc986d..02ff48e0b 100644 --- a/lib/archive_bundle_iterators/database_bundle_iterator.php +++ b/lib/archive_bundle_iterators/database_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,8 +46,7 @@ require_once BASE_DIR.'/lib/utility.php'; * database * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class DatabaseBundleIterator extends ArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/mediawiki_bundle_iterator.php b/lib/archive_bundle_iterators/mediawiki_bundle_iterator.php index c024a760c..024e09054 100644 --- a/lib/archive_bundle_iterators/mediawiki_bundle_iterator.php +++ b/lib/archive_bundle_iterators/mediawiki_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -79,8 +77,7 @@ EOD * for the purpose making an index of these records * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class MediaWikiArchiveBundleIterator extends TextArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php b/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php index c15072884..3844fa19c 100644 --- a/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -52,8 +50,7 @@ require_once BASE_DIR."/controllers/search_controller.php"; * the query terms for this crawl mix will have site:any raw 1 appended to them * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator */ class MixArchiveBundleIterator extends ArchiveBundleIterator implements CrawlConstants diff --git a/lib/archive_bundle_iterators/odp_rdf_bundle_iterator.php b/lib/archive_bundle_iterators/odp_rdf_bundle_iterator.php index d78376646..4accfb9d5 100644 --- a/lib/archive_bundle_iterators/odp_rdf_bundle_iterator.php +++ b/lib/archive_bundle_iterators/odp_rdf_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR. * for the purpose making an index of these records * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class OdpRdfArchiveBundleIterator extends TextArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/text_archive_bundle_iterator.php b/lib/archive_bundle_iterators/text_archive_bundle_iterator.php index 6d8d60c20..ebe0ead62 100644 --- a/lib/archive_bundle_iterators/text_archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/text_archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR.'/lib/utility.php'; * text-oriented records * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class TextArchiveBundleIterator extends ArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/warc_archive_bundle_iterator.php b/lib/archive_bundle_iterators/warc_archive_bundle_iterator.php index 7e3f00d9d..b3a0a53b7 100644 --- a/lib/archive_bundle_iterators/warc_archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/warc_archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR. * Iteration is done for the purpose making an index of these records * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class WarcArchiveBundleIterator extends TextArchiveBundleIterator diff --git a/lib/archive_bundle_iterators/web_archive_bundle_iterator.php b/lib/archive_bundle_iterators/web_archive_bundle_iterator.php index fff3c3da2..2a1a8c07c 100644 --- a/lib/archive_bundle_iterators/web_archive_bundle_iterator.php +++ b/lib/archive_bundle_iterators/web_archive_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ require_once BASE_DIR. * of re-indexing these documents. * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\archive_bundle_iterator * @see WebArchiveBundle */ class WebArchiveBundleIterator extends ArchiveBundleIterator diff --git a/lib/bloom_filter_bundle.php b/lib/bloom_filter_bundle.php index 3affef9bc..4e90763fe 100644 --- a/lib/bloom_filter_bundle.php +++ b/lib/bloom_filter_bundle.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * added to the bundle so that more data can be stored. * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library * @see BloomFilterFile */ class BloomFilterBundle diff --git a/lib/bloom_filter_file.php b/lib/bloom_filter_file.php index 2908b2f7f..e2e687448 100755 --- a/lib/bloom_filter_file.php +++ b/lib/bloom_filter_file.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once "utility.php"; * used to check membership in the set. * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class BloomFilterFile extends PersistentStructure { @@ -172,4 +169,4 @@ class BloomFilterFile extends PersistentStructure return ($this->filter[$byte] & chr(1 << $bit_in_byte)) != chr(0); } } -?> \ No newline at end of file +?> diff --git a/lib/browser_runner.php b/lib/browser_runner.php index 270f0bf62..c99b8ea8b 100644 --- a/lib/browser_runner.php +++ b/lib/browser_runner.php @@ -17,8 +17,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -29,8 +27,7 @@ * Used to execute browser-based Javascript and browser page rendering from PHP. * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage lib + * @package seek_quarry\library */ class BrowserRunner { @@ -47,10 +44,10 @@ class BrowserRunner } } /** - * Runs a Javascript in the current headless browser instance and - * return the results as either a JSON or PHP object. - * @param string $script Javascript to run in browser - * @param string $decode_json whether to leave result as is or to convert + * Runs a Javascript in the current headless browser instance and + * return the results as either a JSON or PHP object. + * @param string $script Javascript to run in browser + * @param string $decode_json whether to leave result as is or to convert * from JSON to a PHP object */ function execute($script, $decode_json = false) diff --git a/lib/btree.php b/lib/btree.php index 3dfcc7910..c70b5c62c 100644 --- a/lib/btree.php +++ b/lib/btree.php @@ -24,8 +24,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage bin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,7 +42,7 @@ define('MIN_DEGREE', 501); * Edition, 2001, The MIT Press * * @author Akshat Kukreti - * @package seek_quarry + * @package seek_quarry\library */ class BTree { diff --git a/lib/bzip2_block_iterator.php b/lib/bzip2_block_iterator.php index 1ea628e3f..6cad7d45b 100644 --- a/lib/bzip2_block_iterator.php +++ b/lib/bzip2_block_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Shawn Tice, (docs added by Chris Pollett chris@pollett.org) - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,7 +40,7 @@ if(!defined('BASE_DIR') && php_sapi_name() != 'cli') { * it left off. * * @author Shawn Tice, (some docs added by Chris Pollett chris@pollett.org) - * @package seek_quarry + * @package seek_quarry\library */ class BZip2BlockIterator { diff --git a/lib/centroid_summarizer.php b/lib/centroid_summarizer.php index 53170dd2f..54ce1654d 100644 --- a/lib/centroid_summarizer.php +++ b/lib/centroid_summarizer.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Mangesh Dahale mangeshadahale@gmail.com - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,6 +45,8 @@ require_once BASE_DIR."/lib/phrase_parser.php"; * Class which may be used by TextProcessors to get a summary for a text * document that may later be used for indexing. It does this by doing * centroid-based clustering. It also generates a word cloud for a document + * @author Mangesh Dahale mangeshadahale@gmail.com + * @package seek_quarry\library */ class CentroidSummarizer { diff --git a/lib/classifiers/classifier.php b/lib/classifiers/classifier.php index 693a35fb8..c04ce950f 100644 --- a/lib/classifiers/classifier.php +++ b/lib/classifiers/classifier.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -123,8 +121,7 @@ require_once BASE_DIR."/lib/phrase_parser.php"; * storage back to disk when (or if) the classifier is serialized again. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ class Classifier implements CrawlConstants { diff --git a/lib/classifiers/classifier_algorithm.php b/lib/classifiers/classifier_algorithm.php index e6384003f..0f50f4187 100644 --- a/lib/classifiers/classifier_algorithm.php +++ b/lib/classifiers/classifier_algorithm.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * classification algorithms can take advantage of. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ abstract class ClassifierAlgorithm { diff --git a/lib/classifiers/feature_selection.php b/lib/classifiers/feature_selection.php index ea4a2d86d..0846d1d56 100644 --- a/lib/classifiers/feature_selection.php +++ b/lib/classifiers/feature_selection.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * new ones. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ abstract class FeatureSelection { diff --git a/lib/classifiers/features.php b/lib/classifiers/features.php index 5e49fa7d2..0d7a29ae1 100644 --- a/lib/classifiers/features.php +++ b/lib/classifiers/features.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ * always has a value of one. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ abstract class Features { @@ -589,4 +586,4 @@ class SparseMatrix implements Iterator //Iterator is built-in to PHP */ function valid() { return !is_null(key($this->data)); } } -?> \ No newline at end of file +?> diff --git a/lib/classifiers/lasso_regression.php b/lib/classifiers/lasso_regression.php index 1aed7a63d..e4d474dea 100644 --- a/lib/classifiers/lasso_regression.php +++ b/lib/classifiers/lasso_regression.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -51,8 +49,7 @@ require_once BASE_DIR."/lib/classifiers/classifier_algorithm.php"; * accuracy. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ class LassoRegression extends ClassifierAlgorithm { diff --git a/lib/classifiers/naive_bayes.php b/lib/classifiers/naive_bayes.php index 41e538c48..c5805171e 100644 --- a/lib/classifiers/naive_bayes.php +++ b/lib/classifiers/naive_bayes.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage classifier * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/classifiers/classifier_algorithm.php"; * same dataset in order to form classifier committees. * * @author Shawn Tice - * @package seek_quarry - * @subpackage classifier + * @package seek_quarry\library\classifier */ class NaiveBayes extends ClassifierAlgorithm { diff --git a/lib/compressors/compressor.php b/lib/compressors/compressor.php index da0d460e1..5925c8e49 100755 --- a/lib/compressors/compressor.php +++ b/lib/compressors/compressor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * intention is the filter carries out some kind of string compression. * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library\compressor */ interface Compressor { diff --git a/lib/compressors/gzip_compressor.php b/lib/compressors/gzip_compressor.php index 9f3c99ab1..91bd53904 100755 --- a/lib/compressors/gzip_compressor.php +++ b/lib/compressors/gzip_compressor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/lib/utility.php"; * {@link http://en.wikipedia.org/wiki/Gzip} * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library\compressor */ class GzipCompressor implements Compressor { diff --git a/lib/compressors/non_compressor.php b/lib/compressors/non_compressor.php index 14696fea5..d0bc16883 100755 --- a/lib/compressors/non_compressor.php +++ b/lib/compressors/non_compressor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/lib/utility.php"; * NonCompressor's compress and uncompress filter return the string unchanged * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library\compressor */ class NonCompressor implements Compressor { diff --git a/lib/crawl_constants.php b/lib/crawl_constants.php index 5c2ffa25e..76adf1a5f 100755 --- a/lib/crawl_constants.php +++ b/lib/crawl_constants.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * crawling process * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ interface CrawlConstants { diff --git a/lib/crawl_daemon.php b/lib/crawl_daemon.php index 50a2000d2..a4eddc251 100644 --- a/lib/crawl_daemon.php +++ b/lib/crawl_daemon.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -49,8 +47,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * won't go away after CrawlDaemon:init is called * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class CrawlDaemon implements CrawlConstants { diff --git a/lib/fetch_git_repository_urls.php b/lib/fetch_git_repository_urls.php index 4d190b634..df1a06050 100755 --- a/lib/fetch_git_repository_urls.php +++ b/lib/fetch_git_repository_urls.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ require_once BASE_DIR.'/configs/config.php'; * Library of functions used to fetch Git internal urls * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class FetchGitRepositoryUrls implements CrawlConstants { diff --git a/lib/fetch_url.php b/lib/fetch_url.php index 87bbb5600..151c3accd 100755 --- a/lib/fetch_url.php +++ b/lib/fetch_url.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * * @author Chris Pollett * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class FetchUrl implements CrawlConstants { @@ -746,4 +743,4 @@ class FetchUrl implements CrawlConstants } } } -?> \ No newline at end of file +?> diff --git a/lib/file_cache.php b/lib/file_cache.php index c784083a3..6acc84811 100644 --- a/lib/file_cache.php +++ b/lib/file_cache.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/models/datasources/".DBMS."_manager.php"; * * @author Chris Pollett * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class FileCache { diff --git a/lib/hash_table.php b/lib/hash_table.php index d0dd3df1e..dc21fe1bc 100755 --- a/lib/hash_table.php +++ b/lib/hash_table.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,9 +43,7 @@ require_once "utility.php"; * Weights for the queue must be flaots * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class HashTable extends StringArray { diff --git a/lib/index_archive_bundle.php b/lib/index_archive_bundle.php index 5d8262f55..4f6d49759 100644 --- a/lib/index_archive_bundle.php +++ b/lib/index_archive_bundle.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/lib/index_bundle_iterators/disjoint_iterator.php b/lib/index_bundle_iterators/disjoint_iterator.php index 58b92277d..17e66e4aa 100644 --- a/lib/index_bundle_iterators/disjoint_iterator.php +++ b/lib/index_bundle_iterators/disjoint_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * all belonging to the same index * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class DisjointIterator extends IndexBundleIterator diff --git a/lib/index_bundle_iterators/doc_iterator.php b/lib/index_bundle_iterators/doc_iterator.php index e5e2c35da..e9ee22374 100755 --- a/lib/index_bundle_iterators/doc_iterator.php +++ b/lib/index_bundle_iterators/doc_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * is given in the documentation of IndexArchiveBundle. * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class DocIterator extends IndexBundleIterator @@ -324,4 +321,4 @@ class DocIterator extends IndexBundleIterator } } -?> \ No newline at end of file +?> diff --git a/lib/index_bundle_iterators/group_iterator.php b/lib/index_bundle_iterators/group_iterator.php index c108cd170..2161fb05f 100644 --- a/lib/index_bundle_iterators/group_iterator.php +++ b/lib/index_bundle_iterators/group_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * vaguely analagous to a SQL GROUP BY clause * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class GroupIterator extends IndexBundleIterator diff --git a/lib/index_bundle_iterators/index_bundle_iterator.php b/lib/index_bundle_iterators/index_bundle_iterator.php index 6198ca583..305bab0ee 100644 --- a/lib/index_bundle_iterators/index_bundle_iterator.php +++ b/lib/index_bundle_iterators/index_bundle_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ abstract class IndexBundleIterator implements CrawlConstants diff --git a/lib/index_bundle_iterators/intersect_iterator.php b/lib/index_bundle_iterators/intersect_iterator.php index ab400100b..93281ec90 100644 --- a/lib/index_bundle_iterators/intersect_iterator.php +++ b/lib/index_bundle_iterators/intersect_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * iterator results * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class IntersectIterator extends IndexBundleIterator @@ -543,4 +540,4 @@ class IntersectIterator extends IndexBundleIterator } } } -?> \ No newline at end of file +?> diff --git a/lib/index_bundle_iterators/negation_iterator.php b/lib/index_bundle_iterators/negation_iterator.php index f5af25488..0df4f3d73 100644 --- a/lib/index_bundle_iterators/negation_iterator.php +++ b/lib/index_bundle_iterators/negation_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,12 +34,11 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} */ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; /** - * Used to iterate over the documents which dont' occur in a set of + * Used to iterate over the documents which don't occur in a set of * iterator results * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class NegationIterator extends IndexBundleIterator diff --git a/lib/index_bundle_iterators/network_iterator.php b/lib/index_bundle_iterators/network_iterator.php index 1c73fa39d..6d266482e 100644 --- a/lib/index_bundle_iterators/network_iterator.php +++ b/lib/index_bundle_iterators/network_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,8 +46,7 @@ require_once BASE_DIR.'/lib/analytics_manager.php'; * with regard to a query * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator */ class NetworkIterator extends IndexBundleIterator { @@ -357,4 +354,4 @@ class NetworkIterator extends IndexBundleIterator return $pages; } } - ?> \ No newline at end of file + ?> diff --git a/lib/index_bundle_iterators/union_iterator.php b/lib/index_bundle_iterators/union_iterator.php index cd050f1be..195de83d5 100644 --- a/lib/index_bundle_iterators/union_iterator.php +++ b/lib/index_bundle_iterators/union_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * WordIterator results * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class UnionIterator extends IndexBundleIterator diff --git a/lib/index_bundle_iterators/word_iterator.php b/lib/index_bundle_iterators/word_iterator.php index fe1c0a92b..973a9fe35 100644 --- a/lib/index_bundle_iterators/word_iterator.php +++ b/lib/index_bundle_iterators/word_iterator.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage iterator * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php'; * is given in the documentation of IndexArchiveBundle. * * @author Chris Pollett - * @package seek_quarry - * @subpackage iterator + * @package seek_quarry\library\index_bundle_iterator * @see IndexArchiveBundle */ class WordIterator extends IndexBundleIterator @@ -541,4 +538,4 @@ class WordIterator extends IndexBundleIterator return array($this->current_generation, $this->current_doc_offset); } } -?> \ No newline at end of file +?> diff --git a/lib/index_dictionary.php b/lib/index_dictionary.php index 30891515d..4c713b9a7 100644 --- a/lib/index_dictionary.php +++ b/lib/index_dictionary.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -53,9 +51,7 @@ require_once BASE_DIR.'/lib/crawl_constants.php'; * recursively until there is at most an A file on each level. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class IndexDictionary implements CrawlConstants { diff --git a/lib/index_manager.php b/lib/index_manager.php index beea8547e..2a2ac7953 100644 --- a/lib/index_manager.php +++ b/lib/index_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/lib/index_shard.php b/lib/index_shard.php index c44fd9308..39e716d5c 100644 --- a/lib/index_shard.php +++ b/lib/index_shard.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -70,9 +68,7 @@ require_once BASE_DIR."/lib/crawl_daemon.php"; * component. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class IndexShard extends PersistentStructure implements CrawlConstants diff --git a/lib/indexing_plugins/addresses_plugin.php b/lib/indexing_plugins/addresses_plugin.php index 538c6f82e..90868f61a 100644 --- a/lib/indexing_plugins/addresses_plugin.php +++ b/lib/indexing_plugins/addresses_plugin.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage indexing_plugin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -50,8 +48,7 @@ require_once BASE_DIR."/lib/locale_functions.php"; * ADDRESSES fields of the page's summary. * * @author Chris Pollett - * @package seek_quarry - * @subpackage indexing_plugin + * @package seek_quarry\library\indexing_plugin */ class AddressesPlugin extends IndexingPlugin implements CrawlConstants { diff --git a/lib/indexing_plugins/indexing_plugin.php b/lib/indexing_plugins/indexing_plugin.php index 65f4faa56..894d0f95e 100644 --- a/lib/indexing_plugins/indexing_plugin.php +++ b/lib/indexing_plugins/indexing_plugin.php @@ -24,8 +24,6 @@ * END LICENSE * * @author Priya Gangaraju priya.gangaraju@gmail.com, Chris Pollett - * @package seek_quarry - * @subpackage indexing_plugin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2011 - 2014 @@ -108,8 +106,7 @@ require_once BASE_DIR."/models/datasources/".DBMS."_manager.php"; * directory and you merely need to replace the Yioop folder when upgrading. * * @author Priya Gangaraju, Chris Pollett - * @package seek_quarry - * @subpackage indexing_plugin + * @package seek_quarry\library\indexing_plugin */ abstract class IndexingPlugin { diff --git a/lib/indexing_plugins/recipe_plugin.php b/lib/indexing_plugins/recipe_plugin.php index a65ed8540..5494e0b7a 100644 --- a/lib/indexing_plugins/recipe_plugin.php +++ b/lib/indexing_plugins/recipe_plugin.php @@ -25,8 +25,6 @@ * * @author Priya Gangaraju priya.gangaraju@gmail.com, Chris Pollett * chris@pollett.org - * @package seek_quarry - * @subpackage indexing_plugin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2011 -2014 @@ -88,8 +86,7 @@ require_once BASE_DIR."/controllers/search_controller.php"; * * @author Priya Gangaraju, Chris Pollett (re-organized, added documentation, * updated) - * @package seek_quarry - * @subpackage indexing_plugin + * @package seek_quarry\library\indexing_plugin */ class RecipePlugin extends IndexingPlugin implements CrawlConstants { diff --git a/lib/indexing_plugins/wordfilter_plugin.php b/lib/indexing_plugins/wordfilter_plugin.php index 10ffd153b..e308afef3 100644 --- a/lib/indexing_plugins/wordfilter_plugin.php +++ b/lib/indexing_plugins/wordfilter_plugin.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage indexing_plugin * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -122,7 +120,7 @@ class WordfilterPlugin extends IndexingPlugin implements CrawlConstants */ var $default_rules_string; /** - * + * Sets up the default word string for the word plugin */ function __construct() { diff --git a/lib/javascript_unit_test.php b/lib/javascript_unit_test.php index f0811cd5e..63394afb5 100644 --- a/lib/javascript_unit_test.php +++ b/lib/javascript_unit_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ require_once BASE_DIR.'/lib/unit_test.php'; * Super class of all the test classes testing Javascript functions. * * @author Akash Patel - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class JavascriptUnitTest extends UnitTest { diff --git a/lib/join.php b/lib/join.php index c1ec7139a..ff9371234 100644 --- a/lib/join.php +++ b/lib/join.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * completes * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library * @see WebQueueBundle */ interface Join diff --git a/lib/locale_functions.php b/lib/locale_functions.php index 134d6d5b8..a0c002aa8 100755 --- a/lib/locale_functions.php +++ b/lib/locale_functions.php @@ -26,7 +26,6 @@ * are used throughout the web site part of Yioop! * * @author Chris Pollett chris@pollett.org - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/lib/mail_server.php b/lib/mail_server.php index 06c45bf3f..b89b70371 100644 --- a/lib/mail_server.php +++ b/lib/mail_server.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage lib * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -51,8 +49,7 @@ require_once BASE_DIR."/lib/utility.php"; * $server->send($subject, $from, $to, $message); * * @author Chris Pollett - * @package seek_quarry - * @subpackage lib + * @package seek_quarry\library */ class MailServer { diff --git a/lib/notifier.php b/lib/notifier.php index cf25073b3..506268d11 100755 --- a/lib/notifier.php +++ b/lib/notifier.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -49,8 +47,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * archive. * * @author Chris Pollett - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library * @see WebQueueBundle */ interface Notifier diff --git a/lib/nword_grams.php b/lib/nword_grams.php index 904c9dbca..5732506b0 100644 --- a/lib/nword_grams.php +++ b/lib/nword_grams.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Ravi Dhillon ravi.dhillon@yahoo.com, Chris Pollett - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,9 +42,7 @@ require_once BASE_DIR."/lib/phrase_parser.php"; * * @author Ravi Dhillon (Bigram Version), Chris Pollett (ngrams + rewrite + * support for page count dumps) - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class NWordGrams { @@ -350,4 +346,4 @@ class NWordGrams return array($num_ngrams_found, $max_gram_len); } } -?> \ No newline at end of file +?> diff --git a/lib/page_rule_parser.php b/lib/page_rule_parser.php index 18c852f34..90bc8d1d6 100644 --- a/lib/page_rule_parser.php +++ b/lib/page_rule_parser.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -85,9 +83,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * For each of the above assignments we could have used ".=" instead of "=" * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class PageRuleParser implements CrawlConstants { diff --git a/lib/partial_zip_archive.php b/lib/partial_zip_archive.php index 635ac894b..e16d740ed 100644 --- a/lib/partial_zip_archive.php +++ b/lib/partial_zip_archive.php @@ -26,7 +26,6 @@ * are used throughout the web site part of Yioop! * * @author Chris Pollett chris@pollett.org - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +36,7 @@ * ZIP Archive. * * @author Chris Pollett - * @package seek_quarry - * @subpackage lib + * @package seek_quarry\library */ class PartialZipArchive { @@ -118,11 +116,11 @@ class PartialZipArchive return count($this->zip_file_names); } /** - * Returns the file name for the ith file that was extractable from - * the archive string used in the constructor. + * Returns the file name for the ith file that was extractable from + * the archive string used in the constructor. * - * @param int $index the number of file want - * @return string its corresponding file name + * @param int $index the number of file want + * @return string its corresponding file name */ function getNameIndex($index) { diff --git a/lib/persistent_structure.php b/lib/persistent_structure.php index be676604a..e96b977ab 100755 --- a/lib/persistent_structure.php +++ b/lib/persistent_structure.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,9 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * (read in from) secondary storage. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class PersistentStructure { @@ -113,4 +109,4 @@ class PersistentStructure } } } -?> \ No newline at end of file +?> diff --git a/lib/phrase_parser.php b/lib/phrase_parser.php index 0acc56b07..4d3f5e8c1 100755 --- a/lib/phrase_parser.php +++ b/lib/phrase_parser.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -64,9 +62,7 @@ require_once BASE_DIR."/lib/locale_functions.php"; * Library of functions used to manipulate words and phrases * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class PhraseParser { @@ -1198,4 +1194,4 @@ vaffanculo fok hoer kut lul やりまん 打っ掛け $score = $num_unsafe_terms * $unsafe_count/($len + 1); return $score; } -} \ No newline at end of file +} diff --git a/lib/priority_queue.php b/lib/priority_queue.php index 65a20270e..af1e9c7ae 100755 --- a/lib/priority_queue.php +++ b/lib/priority_queue.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -54,9 +52,7 @@ require_once "crawl_constants.php"; * implemented using heaps * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class PriorityQueue extends StringArray implements CrawlConstants { diff --git a/lib/processors/bmp_processor.php b/lib/processors/bmp_processor.php index 50762d600..08aa57bbe 100644 --- a/lib/processors/bmp_processor.php +++ b/lib/processors/bmp_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/processors/image_processor.php"; * for BMP and ICO files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class BmpProcessor extends ImageProcessor { @@ -96,7 +93,7 @@ class BmpProcessor extends ImageProcessor * and returns a php image object corresponding to it. This is a crude * variation of code from imagecreatewbmp function documentation at php.net * - * @param string $filename = name of + * @param string $bmp_string string with the contents of a bmp file */ function imagecreatefrombmp($bmp_string) { diff --git a/lib/processors/doc_processor.php b/lib/processors/doc_processor.php index 53ed702ce..55c9c7bba 100755 --- a/lib/processors/doc_processor.php +++ b/lib/processors/doc_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/text_processor.php"; * for binary DOC files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class DocProcessor extends TextProcessor { @@ -174,4 +171,4 @@ class DocProcessor extends TextProcessor return $text; } } -?> \ No newline at end of file +?> diff --git a/lib/processors/docx_processor.php b/lib/processors/docx_processor.php index 8203f301e..669b3daa3 100644 --- a/lib/processors/docx_processor.php +++ b/lib/processors/docx_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/partial_zip_archive.php"; * for DOCX files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class DocxProcessor extends TextProcessor { @@ -112,8 +109,7 @@ class DocxProcessor extends TextProcessor * the supplied $site information. * * @param object $dom a document object with links on it - * @param string $sit a string containing a url - * + * @param string $site a string containing a url * @return array links from the $dom object */ static function links($dom, $site) diff --git a/lib/processors/epub_processor.php b/lib/processors/epub_processor.php index 19e054c60..ad22c9b51 100644 --- a/lib/processors/epub_processor.php +++ b/lib/processors/epub_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Vijeth Patil vijeth.patil@gmail.com - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -61,8 +59,7 @@ define('MAX_DOM_LEVEL', 15); * for XML files (those served as application/epub+zip) * * @author Vijeth Patil - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class EpubProcessor extends TextProcessor { diff --git a/lib/processors/gif_processor.php b/lib/processors/gif_processor.php index 47403febf..4be2a863c 100755 --- a/lib/processors/gif_processor.php +++ b/lib/processors/gif_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/processors/image_processor.php"; * for GIF files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class GifProcessor extends ImageProcessor { diff --git a/lib/processors/git_xml_processor.php b/lib/processors/git_xml_processor.php index 681a2265b..0e84ddd7f 100755 --- a/lib/processors/git_xml_processor.php +++ b/lib/processors/git_xml_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * information that involves basically text data * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class GitXmlProcessor extends TextProcessor { diff --git a/lib/processors/gopher_processor.php b/lib/processors/gopher_processor.php index e800f39fa..fed98f02e 100644 --- a/lib/processors/gopher_processor.php +++ b/lib/processors/gopher_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/html_processor.php"; * for gopher protocol pages * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class GopherProcessor extends HtmlProcessor { diff --git a/lib/processors/html_processor.php b/lib/processors/html_processor.php index 801367a1a..94b4211da 100755 --- a/lib/processors/html_processor.php +++ b/lib/processors/html_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -62,8 +60,7 @@ require_once BASE_DIR."/lib/locale_functions.php"; * for HTML files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class HtmlProcessor extends TextProcessor { @@ -570,4 +567,4 @@ class HtmlProcessor extends TextProcessor return strip_tags($text); } } -?> \ No newline at end of file +?> diff --git a/lib/processors/image_processor.php b/lib/processors/image_processor.php index 1da42cdbe..908c71ee7 100755 --- a/lib/processors/image_processor.php +++ b/lib/processors/image_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/lib/processors/page_processor.php"; * information from images * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class ImageProcessor extends PageProcessor { diff --git a/lib/processors/java_processor.php b/lib/processors/java_processor.php index 66fd3b649..d6390a6a8 100755 --- a/lib/processors/java_processor.php +++ b/lib/processors/java_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * information that involves basically text data * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class JavaProcessor extends TextProcessor { diff --git a/lib/processors/jpg_processor.php b/lib/processors/jpg_processor.php index 16def39a3..a076c19ee 100755 --- a/lib/processors/jpg_processor.php +++ b/lib/processors/jpg_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR."/lib/processors/image_processor.php"; * for JPEG files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class JpgProcessor extends ImageProcessor { diff --git a/lib/processors/page_processor.php b/lib/processors/page_processor.php index 2204d61c7..dcd83f4e3 100644 --- a/lib/processors/page_processor.php +++ b/lib/processors/page_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * directory and you merely need to replace the Yioop folder when upgrading. * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ abstract class PageProcessor implements CrawlConstants { diff --git a/lib/processors/pdf_processor.php b/lib/processors/pdf_processor.php index 3cf58fce9..68621b4f0 100755 --- a/lib/processors/pdf_processor.php +++ b/lib/processors/pdf_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/text_processor.php"; * for PDF files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class PdfProcessor extends TextProcessor { diff --git a/lib/processors/png_processor.php b/lib/processors/png_processor.php index 6711acaa4..beb350378 100755 --- a/lib/processors/png_processor.php +++ b/lib/processors/png_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/processors/image_processor.php"; * for PNG files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class PngProcessor extends ImageProcessor { diff --git a/lib/processors/ppt_processor.php b/lib/processors/ppt_processor.php index ede25707d..f03bff14a 100755 --- a/lib/processors/ppt_processor.php +++ b/lib/processors/ppt_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/text_processor.php"; * for PPT files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class PptProcessor extends TextProcessor { diff --git a/lib/processors/pptx_processor.php b/lib/processors/pptx_processor.php index 9a1454417..e8d933743 100644 --- a/lib/processors/pptx_processor.php +++ b/lib/processors/pptx_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Nakul Natu nakul.natu@gmail.com - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPLv3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/partial_zip_archive.php"; * for PPTX files * * @author Nakul Natu - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class PptxProcessor extends TextProcessor { diff --git a/lib/processors/python_processor.php b/lib/processors/python_processor.php index 2152f4af5..11b9554af 100755 --- a/lib/processors/python_processor.php +++ b/lib/processors/python_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -57,8 +55,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * information that involves basically text data * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class PythonProcessor extends TextProcessor { diff --git a/lib/processors/robot_processor.php b/lib/processors/robot_processor.php index 742d16937..41673851f 100644 --- a/lib/processors/robot_processor.php +++ b/lib/processors/robot_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * Processor class used to extract information from robots.txt files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class RobotProcessor extends PageProcessor { diff --git a/lib/processors/rss_processor.php b/lib/processors/rss_processor.php index 0820ed757..564c9e339 100644 --- a/lib/processors/rss_processor.php +++ b/lib/processors/rss_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,8 +46,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * for RSS or Atom files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class RssProcessor extends TextProcessor { diff --git a/lib/processors/rtf_processor.php b/lib/processors/rtf_processor.php index 80652cb9e..b969be73b 100755 --- a/lib/processors/rtf_processor.php +++ b/lib/processors/rtf_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/text_processor.php"; * for RTF files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class RtfProcessor extends TextProcessor { diff --git a/lib/processors/sitemap_processor.php b/lib/processors/sitemap_processor.php index 52ef2af75..07f1c4708 100644 --- a/lib/processors/sitemap_processor.php +++ b/lib/processors/sitemap_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * for sitemap files * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class SitemapProcessor extends TextProcessor { diff --git a/lib/processors/svg_processor.php b/lib/processors/svg_processor.php index 1d4ddcc7d..ebd32e2bd 100644 --- a/lib/processors/svg_processor.php +++ b/lib/processors/svg_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -58,8 +56,7 @@ require_once BASE_DIR."/lib/utility.php"; * processor handling. * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processors */ class SvgProcessor extends TextProcessor { diff --git a/lib/processors/text_processor.php b/lib/processors/text_processor.php index 6987b997b..245c6e5a1 100755 --- a/lib/processors/text_processor.php +++ b/lib/processors/text_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -62,8 +60,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * information that involves basically text data * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class TextProcessor extends PageProcessor { diff --git a/lib/processors/xlsx_processor.php b/lib/processors/xlsx_processor.php index 6d0c9ca2f..42d16b2fb 100644 --- a/lib/processors/xlsx_processor.php +++ b/lib/processors/xlsx_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Tarun Ramaswamy tarun.pepira@gmail.com - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -54,8 +52,7 @@ require_once BASE_DIR."/lib/partial_zip_archive.php"; * for xlsx files * * @author Tarun Ramaswamy - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class XlsxProcessor extends TextProcessor { @@ -198,8 +195,7 @@ class XlsxProcessor extends TextProcessor * the supplied $site information. * * @param object $dom a document object with links on it - * @param string $sit a string containing a url - * + * @param string $site a string containing a url * @return array links from the $dom object */ static function links($dom, $site) diff --git a/lib/processors/xml_processor.php b/lib/processors/xml_processor.php index 47a5327cc..8e057a317 100644 --- a/lib/processors/xml_processor.php +++ b/lib/processors/xml_processor.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage processor * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -56,8 +54,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * for XML files (those served as text/xml) * * @author Chris Pollett - * @package seek_quarry - * @subpackage processor + * @package seek_quarry\library\processor */ class XmlProcessor extends TextProcessor { diff --git a/lib/string_array.php b/lib/string_array.php index 94db7191e..888c12485 100755 --- a/lib/string_array.php +++ b/lib/string_array.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,9 +45,7 @@ require_once "utility.php"; * optimal as possible * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class StringArray extends PersistentStructure { diff --git a/lib/suffix_tree.php b/lib/suffix_tree.php index f0e90811e..ceb5e96ee 100644 --- a/lib/suffix_tree.php +++ b/lib/suffix_tree.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,9 +35,7 @@ * Algorithmica 14 (3): 249–260. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class SuffixTree { diff --git a/lib/thesaurus.php b/lib/thesaurus.php index 85c920c15..d9bea8cfd 100644 --- a/lib/thesaurus.php +++ b/lib/thesaurus.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Shailesh Padave shaileshpadave49@gmail.com - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -61,6 +59,7 @@ require_once BASE_DIR."/lib/phrase_parser.php"; * The score representing one word sense of term * Given that these methods have been implemented if the use_thesaurus field * of that language tokenizer is set to true, the thesaurus will be used. + * @package seek_quarry\library */ class Thesaurus { @@ -353,4 +352,4 @@ class Thesaurus return $idf; } } -?> \ No newline at end of file +?> diff --git a/lib/trie.php b/lib/trie.php index 0d171ba71..482101b4f 100644 --- a/lib/trie.php +++ b/lib/trie.php @@ -24,7 +24,6 @@ * * @author Sandhya Vissapragada, Chris Pollett (separated out this * code into a separate file and cleaned up) - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,9 +35,7 @@ * * @author Sandhya Vissapragada, Chris Pollett (rewrite + * documentation, multi-byte support) - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class Trie { diff --git a/lib/unit_test.php b/lib/unit_test.php index abab31d3e..5b7e20812 100644 --- a/lib/unit_test.php +++ b/lib/unit_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Base class for all the SeekQuarry/Yioop engine Unit tests * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\library */ abstract class UnitTest { diff --git a/lib/upgrade_functions.php b/lib/upgrade_functions.php index b6b9ad34f..b764615a8 100644 --- a/lib/upgrade_functions.php +++ b/lib/upgrade_functions.php @@ -26,7 +26,6 @@ * and locales between different versions of Yioop! * * @author Chris Pollett chris@pollett.org - * @package seek_quarry * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -73,9 +72,9 @@ function upgradeLocales() $locale->extractMergeLocales($force_folders); } /** - * Used to force push the default Public and Wiki pages into the current - * database - * @param object $db datasource to use to upgrade + * Used to force push the default Public and Wiki pages into the current + * database + * @param object& $db datasource to use to upgrade */ function upgradePublicHelpWiki(&$db) { diff --git a/lib/url_parser.php b/lib/url_parser.php index eb0b85af5..87289863e 100755 --- a/lib/url_parser.php +++ b/lib/url_parser.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,9 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Library of functions used to manipulate and to extract components from urls * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class UrlParser { @@ -963,4 +959,4 @@ class UrlParser return $mime_type; } } -?> \ No newline at end of file +?> diff --git a/lib/utility.php b/lib/utility.php index 03a53d725..0cf75d5c3 100755 --- a/lib/utility.php +++ b/lib/utility.php @@ -26,8 +26,6 @@ * functions * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -78,6 +76,24 @@ function yioop_error_handler($errno, $errstr, $errfile, $errline, } echo "</pre>"; } +/** + * Adds delimiters to a regex that may or may not have them + * + * @param string $expression a regex + * @return string rgex with delimiters if not there + */ +function addRegexDelimiters($expression) +{ + $first = $expression; + $len = strlen($expression); + $last = $expression[$len - 1]; + if(($first != $last && $len > 1) || $len == 1) { + $expression = ($first != '/' ) ? + "/".$expression."/" + : "@".$expression."@"; + } + return $expression; +} if(!function_exists("gzdecode")) { /** * A substitute for the PHP 5.3 and higher gzdeocde function for older @@ -107,31 +123,13 @@ if(!function_exists("gzdecode")) { } } /** - * Adds delimiters to a regex that may or may not have them - * - * @param string $expression a regex - * @return string rgex with delimiters if not there - */ -function addRegexDelimiters($expression) -{ - $first = $expression; - $len = strlen($expression); - $last = $expression[$len - 1]; - if(($first != $last && $len > 1) || $len == 1) { - $expression = ($first != '/' ) ? - "/".$expression."/" - : "@".$expression."@"; - } - return $expression; -} -/** - * search for a pcre pattern in a subject from a given offset, - * return position of first match if found -1 otherwise. + * search for a pcre pattern in a subject from a given offset, + * return position of first match if found -1 otherwise. * - * @param string $pattern a Perl compatible regular expression - * @param string $subject to search for pattern in - * @param int $offset character offset into $subject to begin searching from - * @return int position of first match + * @param string $pattern a Perl compatible regular expression + * @param string $subject to search for pattern in + * @param int $offset character offset into $subject to begin searching from + * @return int position of first match */ function preg_search($pattern, $subject, $offset = 0) { @@ -143,14 +141,14 @@ function preg_search($pattern, $subject, $offset = 0) return $pos; } /** - * Replaces a pcre pattern with a replacement in $subject starting from - * some offset. + * Replaces a pcre pattern with a replacement in $subject starting from + * some offset. * - * @param string $pattern a Perl compatible regular expression - * @param string what to replace the pattern with - * @param string $subject to search for pattern in - * @param int $offset character offset into $subject to begin searching from - * @return string result of the replacements + * @param string $pattern a Perl compatible regular expression + * @param string $replacement what to replace the pattern with + * @param string $subject to search for pattern in + * @param int $offset character offset into $subject to begin searching from + * @return string result of the replacements */ function preg_offset_replace($pattern, $replacement, $subject, $offset = 0) { diff --git a/lib/web_archive.php b/lib/web_archive.php index 4a01554ec..6dda99c47 100755 --- a/lib/web_archive.php +++ b/lib/web_archive.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,9 +38,7 @@ require_once "utility.php"; * Code used to manage web archive files * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class WebArchive { diff --git a/lib/web_archive_bundle.php b/lib/web_archive_bundle.php index b68c3541a..2a445bbc5 100755 --- a/lib/web_archive_bundle.php +++ b/lib/web_archive_bundle.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,9 +46,7 @@ require_once BASE_DIR.'/lib/compressors/gzip_compressor.php'; * offsets which restricts the size of the files we can use for wbe archives. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class WebArchiveBundle { diff --git a/lib/web_queue_bundle.php b/lib/web_queue_bundle.php index 582aeb528..71fdb87d4 100755 --- a/lib/web_queue_bundle.php +++ b/lib/web_queue_bundle.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -83,9 +81,7 @@ require_once 'crawl_constants.php'; * </pre> * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class WebQueueBundle implements Notifier { diff --git a/lib/wiki_parser.php b/lib/wiki_parser.php index fcd0293f2..ab6e1de37 100644 --- a/lib/wiki_parser.php +++ b/lib/wiki_parser.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage library * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,9 +38,7 @@ require_once BASE_DIR."/lib/processors/text_processor.php"; * when Yioop indexes mediawiki dumps as from Wikipedia. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage library + * @package seek_quarry\library */ class WikiParser implements CrawlConstants @@ -381,7 +377,11 @@ class WikiParser implements CrawlConstants return $document; } /** - * @param string $document + * Applies all the wiki subsitutions of this WikiParser to the document + * to create an html document + * makes use of @see processProvidedRegexes + * @param string $document a document with wiki syntax + * @return string result of subistutions to make html */ function processRegexes($document) { @@ -398,9 +398,11 @@ class WikiParser implements CrawlConstants return $document; } /** - * @param array $matches - * @param array $replaces - * @param string $document + * Applies a set of transformations from wiki syntax to html to a document + * @param array $matches an array of things to match for + * @param array $replaces what to replace matches with + * @param string $document wiki document to fix + * @return string document after substitutions */ function processProvidedRegexes($matches, $replaces, $document) { @@ -418,7 +420,10 @@ class WikiParser implements CrawlConstants return $document; } /** - * @param string $document + * Replaces with underscores links with spaces, fixes newline issues + * withing span tags + * @param string $document wiki document to fix + * @return string document after substitutions */ function cleanLinksAndParagraphs($document) { diff --git a/locale/ar/resources/locale.js b/locale/ar/resources/locale.js index 49c29708d..6dadd7e44 100755 --- a/locale/ar/resources/locale.js +++ b/locale/ar/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\ar * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -52,4 +51,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/ar/resources/tokenizer.php b/locale/ar/resources/tokenizer.php index 8207857aa..9e0abb49d 100755 --- a/locale/ar/resources/tokenizer.php +++ b/locale/ar/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\ar */ $GLOBALS['CHARGRAMS']['ar'] = 5; ?> diff --git a/locale/bn/resources/locale.js b/locale/bn/resources/locale.js index d9574b5a7..70b04b57c 100755 --- a/locale/bn/resources/locale.js +++ b/locale/bn/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\bn * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -75,4 +74,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/bn/resources/tokenizer.php b/locale/bn/resources/tokenizer.php index 4b9fd6ea1..96e0e52e9 100755 --- a/locale/bn/resources/tokenizer.php +++ b/locale/bn/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Snigdha Rao Parvatneni - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\bn */ $GLOBALS['CHARGRAMS']['bn'] = 5; ?> diff --git a/locale/de/resources/locale.js b/locale/de/resources/locale.js index 97a80281e..34c185939 100755 --- a/locale/de/resources/locale.js +++ b/locale/de/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\de * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -36,7 +35,7 @@ var alpha = "aäbcdefghiïjklmnoöpqrsßtuüvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; @@ -46,4 +45,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/de/resources/tokenizer.php b/locale/de/resources/tokenizer.php index b18ef729c..444e3b943 100755 --- a/locale/de/resources/tokenizer.php +++ b/locale/de/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -34,11 +32,6 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * either contains a stemmer for the language in question or * it specifies how many characters in a char gram * - * @author Chris Pollett - * @package seek_quarry - * @subpackage locale - */ -/** * This class has a collection of methods for German locale specific * tokenization. In particular, it has a stemmer, a stop word remover (for * use mainly in word cloud creation). The stemmer is my stab at re-implementing @@ -50,8 +43,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * a word and tries to produce its stem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\de */ class DeTokenizer { @@ -61,10 +53,12 @@ class DeTokenizer */ static $vowel = 'aeiouyäöü'; /** + * Things that might have an s following them * @var string */ static $s_ending = 'bdfghklmnrt'; /** + * Things that might have an st following them * @var string */ static $st_ending = 'bdfghklmnt'; @@ -411,4 +405,4 @@ class DeTokenizer self::$buffer = $word; } } -?> \ No newline at end of file +?> diff --git a/locale/en-US/resources/locale.js b/locale/en-US/resources/locale.js index e7b33fbef..26cf6362b 100755 --- a/locale/en-US/resources/locale.js +++ b/locale/en-US/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\en-US * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -36,7 +35,7 @@ var alpha = "abcdefghijklmnopqrstuvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; @@ -46,4 +45,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/en-US/resources/tokenizer.php b/locale/en-US/resources/tokenizer.php index 28235a831..a6fe58e2a 100755 --- a/locale/en-US/resources/tokenizer.php +++ b/locale/en-US/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -51,8 +49,7 @@ if(!defined("WORDNET_EXEC")) { * a word and tries to produce its stem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\en-US */ class EnTokenizer { @@ -864,4 +861,4 @@ class EnTokenizer return $tagged_phrase; } } -?> \ No newline at end of file +?> diff --git a/locale/es/resources/locale.js b/locale/es/resources/locale.js index 1f5317f65..be70e280b 100755 --- a/locale/es/resources/locale.js +++ b/locale/es/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\es * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = "aábcdeéfghiíjklmnñioópqrstuúvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/es/resources/tokenizer.php b/locale/es/resources/tokenizer.php index 64c36e093..afdc1a396 100755 --- a/locale/es/resources/tokenizer.php +++ b/locale/es/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -34,11 +32,6 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * either contains a stemmer for the language in question or * it specifies how many characters in a char gram * - * @author Chris Pollett - * @package seek_quarry - * @subpackage locale - */ -/** * This class has a collection of methods for Spanish locale specific * tokenization. In particular, it has a stemmer, a stop word remover (for * use mainly in word cloud creation). The stemmer is my stab at re-implementing @@ -49,8 +42,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * a word and tries to produce its stem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\es */ class EsTokenizer { @@ -412,4 +404,4 @@ class EsTokenizer self::$buffer); } } -?> \ No newline at end of file +?> diff --git a/locale/fa/resources/locale.js b/locale/fa/resources/locale.js index c8c3802d4..facddd76f 100755 --- a/locale/fa/resources/locale.js +++ b/locale/fa/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\fa * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -36,7 +35,7 @@ var alpha = "اب پ ت ث ج چ ح خ د ذ ر ز ژ س ش" + " ص ض ط ظ ع غ ف ق ک گ ل م ن و ه ی"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/fa/resources/tokenizer.php b/locale/fa/resources/tokenizer.php index 9bdb01989..2f8bbc690 100755 --- a/locale/fa/resources/tokenizer.php +++ b/locale/fa/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\fa */ $GLOBALS['CHARGRAMS']['fa'] = 5; ?> diff --git a/locale/fr-FR/resources/locale.js b/locale/fr-FR/resources/locale.js index 564d8b8cd..77ec9b790 100755 --- a/locale/fr-FR/resources/locale.js +++ b/locale/fr-FR/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\fr-FR * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/fr-FR/resources/tokenizer.php b/locale/fr-FR/resources/tokenizer.php index a8f2d0c59..08a900d3f 100755 --- a/locale/fr-FR/resources/tokenizer.php +++ b/locale/fr-FR/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * a word and tries to produce its stem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\fr-FR */ class FrTokenizer { @@ -367,6 +364,7 @@ class FrTokenizer } /** * Stem verb suffixes beginning i + * @param string $ori_word original word before stemming */ static function step2a($ori_word) { @@ -482,4 +480,4 @@ class FrTokenizer self:$buffer = mb_strtolower(self::$buffer); } } -?> \ No newline at end of file +?> diff --git a/locale/he/resources/locale.js b/locale/he/resources/locale.js index e14f7ac7a..992d90246 100755 --- a/locale/he/resources/locale.js +++ b/locale/he/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\he * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/he/resources/tokenizer.php b/locale/he/resources/tokenizer.php index 831856462..ea50a1a72 100755 --- a/locale/he/resources/tokenizer.php +++ b/locale/he/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\he */ $GLOBALS['CHARGRAMS']['he'] = 5; ?> diff --git a/locale/hi/resources/locale.js b/locale/hi/resources/locale.js index a35d1b314..35afd880a 100755 --- a/locale/hi/resources/locale.js +++ b/locale/hi/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Mallika Perepa - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\hi * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/hi/resources/tokenizer.php b/locale/hi/resources/tokenizer.php index a476eb9c1..f6d9dfb65 100755 --- a/locale/hi/resources/tokenizer.php +++ b/locale/hi/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\hi */ $GLOBALS['CHARGRAMS']['hi'] = 5; ?> diff --git a/locale/in-ID/resources/locale.js b/locale/in-ID/resources/locale.js index aa6d73a26..517ea3924 100755 --- a/locale/in-ID/resources/locale.js +++ b/locale/in-ID/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\in-ID * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = "abcdefghijklmnopqrstuvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/in-ID/resources/tokenizer.php b/locale/in-ID/resources/tokenizer.php index b49c986ec..4242a998c 100755 --- a/locale/in-ID/resources/tokenizer.php +++ b/locale/in-ID/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\in */ $GLOBALS['CHARGRAMS']['in'] = 5; $GLOBALS['CHARGRAMS']['in-ID'] = 5; diff --git a/locale/it/resources/locale.js b/locale/it/resources/locale.js index 00896cc98..a144cb524 100755 --- a/locale/it/resources/locale.js +++ b/locale/it/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\it * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = "aåàbcçdeéêfghiîïíjklmnnoôpqrstuûvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/it/resources/tokenizer.php b/locale/it/resources/tokenizer.php index cffe6ca46..7c6d8e2f6 100755 --- a/locale/it/resources/tokenizer.php +++ b/locale/it/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\it */ class ItTokenizer { @@ -752,4 +749,4 @@ class ItTokenizer self::$buffer); } } -?> \ No newline at end of file +?> diff --git a/locale/ja/resources/locale.js b/locale/ja/resources/locale.js index 4defa2a7d..455e8d235 100755 --- a/locale/ja/resources/locale.js +++ b/locale/ja/resources/locale.js @@ -22,11 +22,10 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\ja * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ - * @copyright 2009 - 2015s + * @copyright 2009 - 2015 * @filesource */ /* diff --git a/locale/ja/resources/tokenizer.php b/locale/ja/resources/tokenizer.php index a33178930..73398d71d 100755 --- a/locale/ja/resources/tokenizer.php +++ b/locale/ja/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\ja */ $GLOBALS['CHARGRAMS']['ja'] = 3; ?> diff --git a/locale/kn/resources/locale.js b/locale/kn/resources/locale.js index 4defa2a7d..8403ffeee 100755 --- a/locale/kn/resources/locale.js +++ b/locale/kn/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/kn/resources/tokenizer.php b/locale/kn/resources/tokenizer.php index bc44010d7..21e167327 100755 --- a/locale/kn/resources/tokenizer.php +++ b/locale/kn/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\kn */ $GLOBALS['CHARGRAMS']['kn'] = 5; ?> diff --git a/locale/ko/resources/locale.js b/locale/ko/resources/locale.js index 4defa2a7d..8403ffeee 100755 --- a/locale/ko/resources/locale.js +++ b/locale/ko/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/ko/resources/tokenizer.php b/locale/ko/resources/tokenizer.php index ff59b007a..46db5ce1a 100755 --- a/locale/ko/resources/tokenizer.php +++ b/locale/ko/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\ko */ $GLOBALS['CHARGRAMS']['ko'] = 3; ?> diff --git a/locale/pl/resources/locale.js b/locale/pl/resources/locale.js index 6ee9b8b29..1a377ba40 100755 --- a/locale/pl/resources/locale.js +++ b/locale/pl/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\pl * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = "aąbcćdeęfghijklłmnńoópqrsśtuvwxyzźż"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/pl/resources/tokenizer.php b/locale/pl/resources/tokenizer.php index f75bdaf8a..7abd5cb2a 100755 --- a/locale/pl/resources/tokenizer.php +++ b/locale/pl/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\pl */ $GLOBALS['CHARGRAMS']['pl'] = 5; ?> diff --git a/locale/pt/resources/locale.js b/locale/pt/resources/locale.js index 00896cc98..3daa04482 100755 --- a/locale/pt/resources/locale.js +++ b/locale/pt/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\pt * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = "aåàbcçdeéêfghiîïíjklmnnoôpqrstuûvwxyz"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/pt/resources/tokenizer.php b/locale/pt/resources/tokenizer.php index afbbfc9fe..67067f06b 100755 --- a/locale/pt/resources/tokenizer.php +++ b/locale/pt/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\pt */ -$GLOBALS['CHARGRAMS']['pl'] = 5; +$GLOBALS['CHARGRAMS']['pt'] = 5; ?> diff --git a/locale/ru/resources/locale.js b/locale/ru/resources/locale.js index c6f699103..174c14b2d 100755 --- a/locale/ru/resources/locale.js +++ b/locale/ru/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\ru * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -35,7 +34,7 @@ var alpha = "абвгдеёжзийклмнопрс" + "туфхцчшщъыьэюяіѳѣѵ"; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; /* diff --git a/locale/ru/resources/tokenizer.php b/locale/ru/resources/tokenizer.php index 3a345c893..6728d96f5 100755 --- a/locale/ru/resources/tokenizer.php +++ b/locale/ru/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale */ define('CHAR_LENGTH', 2); /** @@ -52,8 +49,7 @@ define('CHAR_LENGTH', 2); * a word and tries to produce its stem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\ru */ class RuTokenizer { @@ -324,4 +320,4 @@ class RuTokenizer return $word; } } -?> \ No newline at end of file +?> diff --git a/locale/te/resources/locale.js b/locale/te/resources/locale.js index 5099beb7e..4cf2fbca8 100755 --- a/locale/te/resources/locale.js +++ b/locale/te/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\te * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -34,7 +33,7 @@ */ var alpha = ""; /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = { "a":"అ","aa":"ఆ","i":"ఇ","ii":"ఈ","u":"ఉ","uu":"ఊ", diff --git a/locale/te/resources/tokenizer.php b/locale/te/resources/tokenizer.php index 353d245cc..33bb06893 100755 --- a/locale/te/resources/tokenizer.php +++ b/locale/te/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\te */ $GLOBALS['CHARGRAMS']['te'] = 5; ?> diff --git a/locale/th/resources/locale.js b/locale/th/resources/locale.js index 4defa2a7d..d588c5adc 100755 --- a/locale/th/resources/locale.js +++ b/locale/th/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\th * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/th/resources/tokenizer.php b/locale/th/resources/tokenizer.php index cb4e58b06..737d87008 100755 --- a/locale/th/resources/tokenizer.php +++ b/locale/th/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\th */ $GLOBALS['CHARGRAMS']['th'] = 5; ?> diff --git a/locale/tr/resources/locale.js b/locale/tr/resources/locale.js index e86f75ee4..576cbbf70 100755 --- a/locale/tr/resources/locale.js +++ b/locale/tr/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\tr * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -46,4 +45,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/tr/resources/tokenizer.php b/locale/tr/resources/tokenizer.php index c528295d4..338e5ef9e 100755 --- a/locale/tr/resources/tokenizer.php +++ b/locale/tr/resources/tokenizer.php @@ -21,8 +21,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale + * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\tr */ $GLOBALS['CHARGRAMS']['tr'] = 5; ?> diff --git a/locale/vi-VN/resources/locale.js b/locale/vi-VN/resources/locale.js index 680b61698..89aa0e874 100755 --- a/locale/vi-VN/resources/locale.js +++ b/locale/vi-VN/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\vi-VN * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s @@ -42,7 +41,7 @@ var alpha = "bcdghklmnpqrstvđaáà" + //put consonants then vowels /* - * Transliteration maping for this locale + * Transliteration mapping for this locale */ var roman_array = {}; @@ -52,4 +51,4 @@ var roman_array = {}; */ function analyzeQuery() { -} \ No newline at end of file +} diff --git a/locale/vi-VN/resources/tokenizer.php b/locale/vi-VN/resources/tokenizer.php index 2892c8a50..6870f46c9 100755 --- a/locale/vi-VN/resources/tokenizer.php +++ b/locale/vi-VN/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,11 +35,10 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\vi-VN */ /*for Vietnamese neither char gramming or stemming seemed to make sense, so for now this file is blank. */ -?> \ No newline at end of file +?> diff --git a/locale/zh-CN/resources/locale.js b/locale/zh-CN/resources/locale.js index 17f216241..77ec0da2f 100755 --- a/locale/zh-CN/resources/locale.js +++ b/locale/zh-CN/resources/locale.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\locale\zh-CN * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/locale/zh-CN/resources/tokenizer.php b/locale/zh-CN/resources/tokenizer.php index 43f14e72c..e88adcf87 100755 --- a/locale/zh-CN/resources/tokenizer.php +++ b/locale/zh-CN/resources/tokenizer.php @@ -21,8 +21,6 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage locale * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * it specifies how many characters in a char gram * * @author Chris Pollett - * @package seek_quarry - * @subpackage locale + * @package seek_quarry\locale\zh-CN */ class ZhTokenizer diff --git a/models/activity_model.php b/models/activity_model.php index 3ce1d43c6..7932758dd 100755 --- a/models/activity_model.php +++ b/models/activity_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/models/model.php"; * * @author Chris Pollett * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class ActivityModel extends Model { diff --git a/models/captcha_model.php b/models/captcha_model.php index 163b1814a..910dabd78 100755 --- a/models/captcha_model.php +++ b/models/captcha_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,9 +36,7 @@ require_once BASE_DIR."/models/model.php"; * captcha settings for Yioop * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class CaptchaModel extends Model { diff --git a/models/crawl_model.php b/models/crawl_model.php index 259da2c2c..a4e326f15 100755 --- a/models/crawl_model.php +++ b/models/crawl_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,9 +45,7 @@ if(!defined("POST_PROCESSING") && !defined("NO_LOGGING")) { * and handling data from suggest-a-url forms * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class CrawlModel extends ParallelModel implements CrawlConstants { diff --git a/models/cron_model.php b/models/cron_model.php index 77f015cc0..2027d43af 100644 --- a/models/cron_model.php +++ b/models/cron_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/fetch_url.php"; * Used to remember the last time the web app ran periodic activities * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class CronModel extends Model { diff --git a/models/datasources/datasource_manager.php b/models/datasources/datasource_manager.php index 2283278e3..24a91d8ab 100755 --- a/models/datasources/datasource_manager.php +++ b/models/datasources/datasource_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage datasource_manager * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/lib/utility.php"; * filesystem. * * @author Chris Pollett - * @package seek_quarry - * @subpackage datasource_manager + * @package seek_quarry\model\datasource_manager */ abstract class DatasourceManager { @@ -371,4 +368,4 @@ abstract class DatasourceManager return true; } } -?> \ No newline at end of file +?> diff --git a/models/datasources/mysql_manager.php b/models/datasources/mysql_manager.php index ecddd9da0..14fd50715 100755 --- a/models/datasources/mysql_manager.php +++ b/models/datasources/mysql_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage datasource_manager * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -50,9 +48,7 @@ require_once BASE_DIR."/models/datasources/pdo_manager.php"; * of mysqli_ * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage datasource_manager + * @package seek_quarry\model\datasource_manager */ class MysqlManager extends PdoManager { diff --git a/models/datasources/pdo_manager.php b/models/datasources/pdo_manager.php index 21cf504bd..ca4cb64bc 100644 --- a/models/datasources/pdo_manager.php +++ b/models/datasources/pdo_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage datasource_manager * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once "datasource_manager.php"; * @author Chris Pollett * - * @package seek_quarry - * @subpackage datasource_manager + * @package seek_quarry\model\datasource_manager */ class PdoManager extends DatasourceManager { @@ -206,4 +203,4 @@ class PdoManager extends DatasourceManager } -?> \ No newline at end of file +?> diff --git a/models/datasources/sqlite3_manager.php b/models/datasources/sqlite3_manager.php index 170ca6aaa..0cbd13b16 100644 --- a/models/datasources/sqlite3_manager.php +++ b/models/datasources/sqlite3_manager.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage datasource_manager * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/models/datasources/pdo_manager.php"; * * @author Chris Pollett * - * @package seek_quarry - * @subpackage datasource_manager + * @package seek_quarry\model\datasource_manager */ class Sqlite3Manager extends PdoManager { diff --git a/models/group_model.php b/models/group_model.php index eac434a3e..3888d748a 100644 --- a/models/group_model.php +++ b/models/group_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Mallika Perepa, Chris Pollett - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -46,8 +44,7 @@ require_once BASE_DIR."/lib/wiki_parser.php"; * does limited access control checks of these operations. * * @author Mallika Perepa (creator), Chris Pollett (rewrite) - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class GroupModel extends Model { @@ -572,14 +569,14 @@ class GroupModel extends Model return $row; } /** - * Returns an array of user information about users who have contributed - * to a thread or own the group a thread belongs to + * Returns an array of user information about users who have contributed + * to a thread or own the group a thread belongs to * - * @param int $thread_id the id of the thread that want users for - * @param int $owner_id owner of group thread belongs to - * @param int $exclude_id an id of a user to exclude from the array + * @param int $thread_id the id of the thread that want users for + * @param int $owner_id owner of group thread belongs to + * @param int $exclude_id an id of a user to exclude from the array * returned - * @return array user information of users following the thread + * @return array user information of users following the thread */ function getThreadFollowers($thread_id, $owner_id, $exclude_id = -1) { @@ -602,7 +599,6 @@ class GroupModel extends Model unset($rows[$i]); //last one will be null return $rows; } - /** * Creates a new group item * @@ -1179,6 +1175,7 @@ class GroupModel extends Model * @param int $group_id group identifier of group wiki page belongs to * @param int $page_id identifier for page want to parse resources for * @param string $locale_tag the locale of the parsed page. + * @param string $parsed_page the parsed wiki page before resources added * @return string resulting html page */ function insertResourcesParsePage($group_id, $page_id, $locale_tag, @@ -1364,7 +1361,7 @@ class GroupModel extends Model * added to the media_convert folder so that the media_updater can produce * mp4 and webm files corresponding to the video file. * - * @param string $tmp_type tmp location that uploaded file initially stored + * @param string $tmp_name tmp location that uploaded file initially stored * at * @param string $file_name file name of file that has been uploaded * @param string $mime_type mime type of uploaded file @@ -1472,10 +1469,10 @@ class GroupModel extends Model "&g=$group_id&p=$page_id&n=$resource_name"; } /** - * Returns the number of non-empty wiki pages a group has (across all - * locales) - * @param int $group_id id of group to return the number of wiki pages for - * @return int number of wiki pages for that group + * Returns the number of non-empty wiki pages a group has (across all + * locales) + * @param int $group_id id of group to return the number of wiki pages for + * @return int number of wiki pages for that group */ function getGroupPageCount($group_id) { diff --git a/models/locale_model.php b/models/locale_model.php index af60d293d..4cf94a73c 100755 --- a/models/locale_model.php +++ b/models/locale_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -55,8 +53,7 @@ function lessThanLocale($a, $b) { * a given region). * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class LocaleModel extends Model { diff --git a/models/machine_model.php b/models/machine_model.php index a2b785496..883417e19 100644 --- a/models/machine_model.php +++ b/models/machine_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ require_once BASE_DIR."/lib/fetch_url.php"; * db results related to Machine Administration * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class MachineModel extends Model { diff --git a/models/model.php b/models/model.php index 5325e6cce..5060a28bf 100755 --- a/models/model.php +++ b/models/model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -54,9 +52,7 @@ define("MIN_SNIPPET_LENGTH", 100); * support functions for formatting search results * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class Model implements CrawlConstants { diff --git a/models/parallel_model.php b/models/parallel_model.php index 05c217eac..20008e0c9 100755 --- a/models/parallel_model.php +++ b/models/parallel_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -62,9 +60,7 @@ require_once BASE_DIR.'/lib/fetch_url.php'; * Subclasses include @see CrawlModel and @see PhraseModel. * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class ParallelModel extends Model implements CrawlConstants { diff --git a/models/phrase_model.php b/models/phrase_model.php index 8896fb8c6..061bc76a9 100755 --- a/models/phrase_model.php +++ b/models/phrase_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -63,8 +61,7 @@ foreach(glob(BASE_DIR."/lib/index_bundle_iterators/*_iterator.php") * results for a given phrase search * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class PhraseModel extends ParallelModel { diff --git a/models/profile_model.php b/models/profile_model.php index a998259b9..d593da8de 100755 --- a/models/profile_model.php +++ b/models/profile_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,9 +38,7 @@ require_once(BASE_DIR.'/lib/url_parser.php'); * getting and saving the profile.php of the current search engine instance * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class ProfileModel extends Model { @@ -309,7 +305,7 @@ class ProfileModel extends Model * fields of $new_profile_data will be considered). * @param array $old_profile_data fields and values that come from * presumably a previously existing profile - * @param bool whether the new profile data is coming from a reset to + * @param bool $reset whether the new profile data is coming from a reset to * factory settings or not */ function updateProfile($directory, $new_profile_data, $old_profile_data, diff --git a/models/role_model.php b/models/role_model.php index 7cab7dd0e..fc11b84fd 100644 --- a/models/role_model.php +++ b/models/role_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/lib/utility.php"; * db results related to Role Administration * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class RoleModel extends Model { diff --git a/models/searchfilters_model.php b/models/searchfilters_model.php index 2fef8c3af..8c272402d 100644 --- a/models/searchfilters_model.php +++ b/models/searchfilters_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,9 +41,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * filtered from all search results returned by Yioop! * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class SearchfiltersModel extends Model implements CrawlConstants { diff --git a/models/signin_model.php b/models/signin_model.php index 3e9a1d2e8..276ad3130 100755 --- a/models/signin_model.php +++ b/models/signin_model.php @@ -22,9 +22,7 @@ * * END LICENSE * - * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model + * @author Chris Pollett chris@pollett.orgs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,9 +38,7 @@ require_once BASE_DIR."/lib/utility.php"; * db results needed for a user to login * * @author Chris Pollett - * - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class SigninModel extends Model { diff --git a/models/source_model.php b/models/source_model.php index da8c52a3e..1ef666c5e 100644 --- a/models/source_model.php +++ b/models/source_model.php @@ -22,9 +22,7 @@ * * END LICENSE * - * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model + * @author Chris Pollett chris@pollett.orgs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/phrase_parser.php"; * Also, used to manage data about available subsearches seen in SearchView * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class SourceModel extends ParallelModel { @@ -368,7 +365,7 @@ class SourceModel extends ParallelModel * Gets a list of rss news feed info either from the local database or * from the name server (in multiple news feeder setting) * - * @param bool whether to use a previously cached news list + * @param bool $use_cache whether to use a previously cached news list * @return array $feeds info about all the news sources this machine * is responsible for */ diff --git a/models/user_model.php b/models/user_model.php index 59bbbb07e..695d4c33f 100755 --- a/models/user_model.php +++ b/models/user_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/lib/processors/image_processor.php"; * database statements related to User Administration * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class UserModel extends Model { @@ -279,10 +276,10 @@ class UserModel extends Model return $row; } /** - * Returns the relative url needed to request the given users avatar icon + * Returns the relative url needed to request the given users avatar icon * - * @param int $user_id user to look up path for - * @return string path to icon + * @param int $user_id user to look up path for + * @return string path to icon */ function getUserIconUrl($user_id) { @@ -473,4 +470,4 @@ class UserModel extends Model $this->db->execute($sql, $params); } } -?> \ No newline at end of file +?> diff --git a/models/visitor_model.php b/models/visitor_model.php index 64791f428..10aa408c2 100644 --- a/models/visitor_model.php +++ b/models/visitor_model.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage model * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ require_once BASE_DIR."/models/model.php"; * attempts * * @author Chris Pollett - * @package seek_quarry - * @subpackage model + * @package seek_quarry\model */ class VisitorModel extends Model { diff --git a/privacy.php b/privacy.php index 6dcb90d39..f4a4a2835 100755 --- a/privacy.php +++ b/privacy.php @@ -26,8 +26,6 @@ * the SeekQuarry/Yioop Search engine * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage static * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/basic.js b/scripts/basic.js index 1e314e6ad..d69e6e970 100755 --- a/scripts/basic.js +++ b/scripts/basic.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/big_int.js b/scripts/big_int.js index 56676a678..0f23233da 100644 --- a/scripts/big_int.js +++ b/scripts/big_int.js @@ -23,8 +23,7 @@ * * @author Akash Patel (edited by Chris Pollett chris@pollett.org) * Ideas adapted Leemon Baird's bigint.js - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -672,4 +671,4 @@ function expand(x, n) (x.length > n ? x.length : n) * bits_per_element, 0); copyBigIntFromBigInt(ans, x); return ans; -} \ No newline at end of file +} diff --git a/scripts/classifiers.js b/scripts/classifiers.js index 4944d69ec..9c672bdf1 100644 --- a/scripts/classifiers.js +++ b/scripts/classifiers.js @@ -38,8 +38,7 @@ * button clicks. * * @author Shawn Tice - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript */ var Classifier = (function() { /* diff --git a/scripts/hash_captcha.js b/scripts/hash_captcha.js index fae0e82d1..875c1a0d6 100644 --- a/scripts/hash_captcha.js +++ b/scripts/hash_captcha.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/help.js b/scripts/help.js index 1930e6722..bacd1b2e1 100644 --- a/scripts/help.js +++ b/scripts/help.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/history.js b/scripts/history.js index 0886ef651..19205e58a 100644 --- a/scripts/history.js +++ b/scripts/history.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Akshat Kukreti - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/mix.js b/scripts/mix.js index 2fe09b412..c44afccea 100644 --- a/scripts/mix.js +++ b/scripts/mix.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/scripts/sha1.js b/scripts/sha1.js index 44d234b2e..88cb89317 100644 --- a/scripts/sha1.js +++ b/scripts/sha1.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/scripts/suggest.js b/scripts/suggest.js index 4b7a506b9..e1af5c1d1 100644 --- a/scripts/suggest.js +++ b/scripts/suggest.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Sandhya Vissapragada, Chris Pollett - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015s diff --git a/scripts/wiki.js b/scripts/wiki.js index cb5e29038..aa47063e1 100755 --- a/scripts/wiki.js +++ b/scripts/wiki.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala (edited Chris Pollett) - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2014 diff --git a/scripts/zkp.js b/scripts/zkp.js index 37db35b5a..30feb6815 100644 --- a/scripts/zkp.js +++ b/scripts/zkp.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Akash Patel (edited by Chris Pollett chris@pollett.org) - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -243,4 +242,4 @@ function registration(password_id, repassword_id, modulus_id) var z = multMod(x, x, n); password.value = bigInt2Str(z, 10); repassword.value = bigInt2Str(z, 10); -} \ No newline at end of file +} diff --git a/terms.php b/terms.php index 4fdfdf278..0aa4feb76 100755 --- a/terms.php +++ b/terms.php @@ -26,8 +26,6 @@ * the use of this web site * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage static * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/bloom_filter_file_test.php b/tests/bloom_filter_file_test.php index 434cc860f..beba12209 100755 --- a/tests/bloom_filter_file_test.php +++ b/tests/bloom_filter_file_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ require_once BASE_DIR."/lib/bloom_filter_file.php"; * membership testing * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class BloomFilterFileTest extends UnitTest { diff --git a/tests/btree_test.php b/tests/btree_test.php index 95cc2541b..27211cd68 100644 --- a/tests/btree_test.php +++ b/tests/btree_test.php @@ -24,8 +24,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -60,8 +58,7 @@ define('NUM_VALS', 25); * Used to test insert, lookup, and deletion of key-value pairs on the B-Tree. * * @author Akshat Kukreti - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class BTreeTest extends UnitTest { diff --git a/tests/de_tokenizer_test.php b/tests/de_tokenizer_test.php index 816e3e447..f17d10bd8 100644 --- a/tests/de_tokenizer_test.php +++ b/tests/de_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * http://snowball.tartarus.org/algorithms/german/output.txt * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class DeTokenizerTest extends UnitTest { diff --git a/tests/docx_processor_test.php b/tests/docx_processor_test.php index f4d03e1b0..d24632c68 100644 --- a/tests/docx_processor_test.php +++ b/tests/docx_processor_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Nakul Natu nakul.natu@gmail.com - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."lib/processors/docx_processor.php"; * docx files which are a zip of an xml-based format * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class DocxProcessorTest extends UnitTest implements CrawlConstants { diff --git a/tests/en_tokenizer_test.php b/tests/en_tokenizer_test.php index c7664b6d2..ed2a88e1a 100644 --- a/tests/en_tokenizer_test.php +++ b/tests/en_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,8 +46,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * Code uses orginal Porter stemmer, not Porter 2 * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class EnTokenizerTest extends UnitTest { diff --git a/tests/epub_processor_test.php b/tests/epub_processor_test.php index 16bb11fe8..38c5b14bf 100644 --- a/tests/epub_processor_test.php +++ b/tests/epub_processor_test.php @@ -22,9 +22,7 @@ * * END LICENSE * - * @author Vijeth Patil vijeth.patil@gmail.com - * @package seek_quarry - * @subpackage test + * @author Vijeth Patil vijeth.patil@gmail.coms * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -55,8 +53,7 @@ require_once BASE_DIR."/lib/unit_test.php"; * * * @author Vijeth Patil - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class EpubProcessorTest extends UnitTest implements CrawlConstants { diff --git a/tests/es_tokenizer_test.php b/tests/es_tokenizer_test.php index f5d9bbec1..a6e3585cb 100644 --- a/tests/es_tokenizer_test.php +++ b/tests/es_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * http://snowball.tartarus.org/algorithms/spanish/output.txt * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class EsTokenizerTest extends UnitTest { diff --git a/tests/fr_tokenizer_test.php b/tests/fr_tokenizer_test.php index d0fe5d1ad..993d7f2b5 100644 --- a/tests/fr_tokenizer_test.php +++ b/tests/fr_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * http://snowball.tartarus.org/algorithms/french/output.txt * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class FrTokenizerTest extends UnitTest { diff --git a/tests/hash_table_test.php b/tests/hash_table_test.php index b23f179b3..294d7bc93 100755 --- a/tests/hash_table_test.php +++ b/tests/hash_table_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR.'/lib/utility.php'; * table is full * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class HashTableTest extends UnitTest { diff --git a/tests/index.php b/tests/index.php index 83a3010c9..2962bbb90 100644 --- a/tests/index.php +++ b/tests/index.php @@ -26,8 +26,6 @@ * the SeekQuarry/Yioop Search engine * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -164,6 +162,9 @@ function runBrowserTests() /** * This is a utility function to get the Full URL of the current page. + * @param bool $strip_query_params whether to get rid of the query string + * or not + * @return string full url */ function getFullURL($strip_query_params = false) { diff --git a/tests/index_shard_test.php b/tests/index_shard_test.php index c75b302de..8c466d58e 100644 --- a/tests/index_shard_test.php +++ b/tests/index_shard_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -49,8 +47,7 @@ require_once BASE_DIR."/lib/index_shard.php"; * updated, shards can be saved and reloaded * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class IndexShardTest extends UnitTest { diff --git a/tests/it_tokenizer_test.php b/tests/it_tokenizer_test.php index 2b8c2c00f..afbe2acb7 100644 --- a/tests/it_tokenizer_test.php +++ b/tests/it_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * http://snowball.tartarus.org/algorithms/italian/output.txt * * @author Akshat Kukreti - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class ItTokenizerTest extends UnitTest { diff --git a/tests/many_user_experiment.php b/tests/many_user_experiment.php index b47cd5c6c..9e90e3613 100644 --- a/tests/many_user_experiment.php +++ b/tests/many_user_experiment.php @@ -25,9 +25,7 @@ * Test to see for big strings which how long various string concatenation * operations take. * - * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test + * @author Chris Pollett chris@pollett.orgs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/mobile_ui_tests.js b/tests/mobile_ui_tests.js index ed99e9fe6..ebefa9389 100644 --- a/tests/mobile_ui_tests.js +++ b/tests/mobile_ui_tests.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/pdf_processor_test.php b/tests/pdf_processor_test.php index 863cc3348..f8cb40907 100644 --- a/tests/pdf_processor_test.php +++ b/tests/pdf_processor_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -54,8 +52,7 @@ require_once BASE_DIR."/lib/unit_test.php"; * * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class PdfProcessorTest extends UnitTest implements CrawlConstants { diff --git a/tests/phantomjs_runner.js b/tests/phantomjs_runner.js index 4674b0e2d..0669a816d 100644 --- a/tests/phantomjs_runner.js +++ b/tests/phantomjs_runner.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/phantomjs_ui_test.php b/tests/phantomjs_ui_test.php index 9fda6c0dc..82b3a456b 100644 --- a/tests/phantomjs_ui_test.php +++ b/tests/phantomjs_ui_test.php @@ -17,8 +17,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -29,8 +27,7 @@ * Used to test the UI using PhantomJs. * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class PhantomjsUiTest extends JavascriptUnitTest { diff --git a/tests/phrase_parser_test.php b/tests/phrase_parser_test.php index c730a231b..4f4d3c18b 100644 --- a/tests/phrase_parser_test.php +++ b/tests/phrase_parser_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/locale_functions.php"; * extracting works correctly * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class PhraseParserTest extends UnitTest { diff --git a/tests/pptx_processor_test.php b/tests/pptx_processor_test.php index 477f40f4d..b4d1f0ebf 100644 --- a/tests/pptx_processor_test.php +++ b/tests/pptx_processor_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Nakul Natu nakul.natu@gmail.com - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."lib/processors/pptx_processor.php"; * pptx files which are a zip of an xml-based format * * @author Nakul Natu - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class PptxProcessorTest extends UnitTest implements CrawlConstants { diff --git a/tests/priority_queue_test.php b/tests/priority_queue_test.php index da5e418b5..93068448e 100755 --- a/tests/priority_queue_test.php +++ b/tests/priority_queue_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/lib/priority_queue.php"; * to crawl next * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class PriorityQueueTest extends UnitTest { diff --git a/tests/queue_server_test.php b/tests/queue_server_test.php index f927dda05..92187dad6 100644 --- a/tests/queue_server_test.php +++ b/tests/queue_server_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -43,8 +41,7 @@ require_once BASE_DIR."/bin/queue_server.php"; * a web crawl (the responsibility of a QueueServer) * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class QueueServerTest extends UnitTest { diff --git a/tests/ru_tokenizer_test.php b/tests/ru_tokenizer_test.php index 18b4481db..50a416040 100644 --- a/tests/ru_tokenizer_test.php +++ b/tests/ru_tokenizer_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -47,8 +45,7 @@ require_once BASE_DIR.'lib/unit_test.php'; * http://snowball.tartarus.org/algorithms/russian/output.txt * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class RuTokenizerTest extends UnitTest { diff --git a/tests/sha1_javascript_test.php b/tests/sha1_javascript_test.php index ff3c1b524..85dfcdfa6 100644 --- a/tests/sha1_javascript_test.php +++ b/tests/sha1_javascript_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -33,8 +31,7 @@ /** * Used to test the Javascript implementation of the sha1 function. * @author Akash Patel - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class Sha1JavascriptTest extends JavascriptUnitTest { diff --git a/tests/socket_experiment.php b/tests/socket_experiment.php index ba3d1d89f..7e5b09f39 100755 --- a/tests/socket_experiment.php +++ b/tests/socket_experiment.php @@ -36,8 +36,6 @@ * </pre> * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/string_array_test.php b/tests/string_array_test.php index dca574fc9..e61ed1492 100644 --- a/tests/string_array_test.php +++ b/tests/string_array_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/lib/string_array.php"; * and can handle loading and saving * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class StringArrayTest extends UnitTest { diff --git a/tests/string_cat_experiment.php b/tests/string_cat_experiment.php index 2cc072e6d..3a487f4a2 100644 --- a/tests/string_cat_experiment.php +++ b/tests/string_cat_experiment.php @@ -26,8 +26,6 @@ * operations take. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/test_files/german_stemmer/vocab_sampler.php b/tests/test_files/german_stemmer/vocab_sampler.php index 7610e7c2a..bc55e33c7 100644 --- a/tests/test_files/german_stemmer/vocab_sampler.php +++ b/tests/test_files/german_stemmer/vocab_sampler.php @@ -1,24 +1,59 @@ <?php - $words = file("input_vocabulary.txt"); - $stems = file("stemmed_result.txt"); - $num_words = count($words); - $num_samples = 1000; - $sample_words = array(); - $sample_stems = array(); - $indices = array(); - for($i = 0; $i < $num_samples; $i++) { - do { - $rand = rand(0, $num_words - 1); - } while(isset($indices[$rand])); - $indices[$rand] = true; - } - $indices = array_keys($indices); - sort($indices); - for($i = 0; $i < $num_samples; $i++) { - $index = $indices[$i]; - $sample_words[] = trim($words[$index]); - $sample_stems[] = trim($stems[$index]); - } - file_put_contents("2input_vocabulary.txt", implode("\n", $sample_words)); - file_put_contents("2stemmed_result.txt", implode("\n", $sample_stems)); +/** + * SeekQuarry/Yioop -- + * Open Source Pure PHP Search Engine, Crawler, and Indexer + * + * Copyright (C) 2009 - 2015 Chris Pollett chris@pollett.org + * + * LICENSE: + * + * This program 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. + * + * This program 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 this program. If not, see <http://www.gnu.org/licenses/>. + * + * END LICENSE + * + * @author Chris Pollett chris@pollett.org + * @license http://www.gnu.org/licenses/ GPL3 + * @link http://www.seekquarry.com/ + * @copyright 2009 - 2015 + * @filesource + */ +/** + * Quick and dirty program to take a file with >1000 stemming examples + * and to randonly choose a 1000 for testing purposes so that we don't have + * to have the large file in the repository + * @author Chris Pollett chris@pollett.org + */ +$words = file("input_vocabulary.txt"); +$stems = file("stemmed_result.txt"); +$num_words = count($words); +$num_samples = 1000; +$sample_words = array(); +$sample_stems = array(); +$indices = array(); +for($i = 0; $i < $num_samples; $i++) { + do { + $rand = rand(0, $num_words - 1); + } while(isset($indices[$rand])); + $indices[$rand] = true; +} +$indices = array_keys($indices); +sort($indices); +for($i = 0; $i < $num_samples; $i++) { + $index = $indices[$i]; + $sample_words[] = trim($words[$index]); + $sample_stems[] = trim($stems[$index]); +} +file_put_contents("2input_vocabulary.txt", implode("\n", $sample_words)); +file_put_contents("2stemmed_result.txt", implode("\n", $sample_stems)); ?> diff --git a/tests/test_files/vocab_sampler.php b/tests/test_files/vocab_sampler.php index cf6d583d0..195b5b5dd 100644 --- a/tests/test_files/vocab_sampler.php +++ b/tests/test_files/vocab_sampler.php @@ -26,8 +26,6 @@ * operations take. * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/trie_test.php b/tests/trie_test.php index 63b435cb2..1c8f1f978 100755 --- a/tests/trie_test.php +++ b/tests/trie_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR.'/lib/utility.php'; * could be used for an autosuggest dictionary * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class TrieTest extends UnitTest { diff --git a/tests/url_parser_test.php b/tests/url_parser_test.php index c35800fbc..d5260f219 100644 --- a/tests/url_parser_test.php +++ b/tests/url_parser_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/url_parser.php"; * isPathMemberRegexPaths (used in robot_processor.php) works * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class UrlParserTest extends UnitTest { diff --git a/tests/utility_test.php b/tests/utility_test.php index 81c667abc..aab7d7126 100644 --- a/tests/utility_test.php +++ b/tests/utility_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * related to posting lists. * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class UtilityTest extends UnitTest { diff --git a/tests/web_archive_test.php b/tests/web_archive_test.php index 2fb86dec4..57b033bbe 100755 --- a/tests/web_archive_test.php +++ b/tests/web_archive_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -46,8 +44,7 @@ require_once BASE_DIR."/lib/compressors/gzip_compressor.php"; * retreiving from such an archive. * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class WebArchiveTest extends UnitTest { diff --git a/tests/web_queue_bundle_test.php b/tests/web_queue_bundle_test.php index 72e36d6dd..d406c47f2 100644 --- a/tests/web_queue_bundle_test.php +++ b/tests/web_queue_bundle_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/web_queue_bundle.php"; * UnitTest for the WebQueueBundle class. * * @author Chris Pollett - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class WebQueueBundleTest extends UnitTest { diff --git a/tests/web_ui_tests.js b/tests/web_ui_tests.js index 9278f00b0..945a96c12 100644 --- a/tests/web_ui_tests.js +++ b/tests/web_ui_tests.js @@ -22,8 +22,7 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage javascript + * @package seek_quarry\javascript * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/tests/xlsx_processor_test.php b/tests/xlsx_processor_test.php index 41f3958ce..b95c980bf 100644 --- a/tests/xlsx_processor_test.php +++ b/tests/xlsx_processor_test.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Tarun Ramaswamy tarun.pepira@gmail.com - * @package seek_quarry - * @subpackage test * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR."/lib/processors/xlsx_processor.php"; * of getting the tile, description, languages and links * * @author Tarun Ramaswamy - * @package seek_quarry - * @subpackage test + * @package seek_quarry\test */ class XlsxProcessorTest extends UnitTest implements CrawlConstants { diff --git a/views/admin_view.php b/views/admin_view.php index 1168de7c8..0034a3132 100755 --- a/views/admin_view.php +++ b/views/admin_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * site. * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class AdminView extends View { diff --git a/views/api_view.php b/views/api_view.php index fa8ff467b..28afd1a44 100644 --- a/views/api_view.php +++ b/views/api_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * wiki pages for public groups when not logged. * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class ApiView extends View { diff --git a/views/crawlstatus_view.php b/views/crawlstatus_view.php index 919690dfc..259bb500d 100755 --- a/views/crawlstatus_view.php +++ b/views/crawlstatus_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * crawls that have been made by this seek_quarry instance * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class CrawlstatusView extends View { @@ -272,4 +269,4 @@ class CrawlstatusView extends View <?php } } -?> \ No newline at end of file +?> diff --git a/views/elements/activity_element.php b/views/elements/activity_element.php index fd7c21c03..f426f5387 100755 --- a/views/elements/activity_element.php +++ b/views/elements/activity_element.php @@ -22,9 +22,7 @@ * * END LICENSE * - * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element + * @author Chris Pollett chris@pollett.orgs * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ActivityElement extends Element { diff --git a/views/elements/api_element.php b/views/elements/api_element.php index a7444a3a2..d29aaca1a 100644 --- a/views/elements/api_element.php +++ b/views/elements/api_element.php @@ -24,8 +24,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/views/elements/configure_element.php b/views/elements/configure_element.php index 1db9197da..9928ff9ed 100644 --- a/views/elements/configure_element.php +++ b/views/elements/configure_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * identifier information. * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ConfigureElement extends Element { diff --git a/views/elements/crawloptions_element.php b/views/elements/crawloptions_element.php index a7fee43d0..73cb7354f 100644 --- a/views/elements/crawloptions_element.php +++ b/views/elements/crawloptions_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class CrawloptionsElement extends Element { diff --git a/views/elements/editclassifier_element.php b/views/elements/editclassifier_element.php index fca62beea..c5033fbb6 100644 --- a/views/elements/editclassifier_element.php +++ b/views/elements/editclassifier_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * made to the server. * * @author Shawn Tice - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class EditclassifierElement extends Element { diff --git a/views/elements/editlocales_element.php b/views/elements/editlocales_element.php index 4abbfba57..3d648014c 100644 --- a/views/elements/editlocales_element.php +++ b/views/elements/editlocales_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class EditlocalesElement extends Element { diff --git a/views/elements/editmix_element.php b/views/elements/editmix_element.php index aa7bf872e..a38659053 100644 --- a/views/elements/editmix_element.php +++ b/views/elements/editmix_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Element responsible for displaying info about a given crawl mix * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class EditmixElement extends Element { diff --git a/views/elements/element.php b/views/elements/element.php index 8902fd371..b5c8ae18e 100755 --- a/views/elements/element.php +++ b/views/elements/element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ abstract class Element { diff --git a/views/elements/footer_element.php b/views/elements/footer_element.php index edaeb7844..933dda958 100755 --- a/views/elements/footer_element.php +++ b/views/elements/footer_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * pages * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class FooterElement extends Element { diff --git a/views/elements/groupfeed_element.php b/views/elements/groupfeed_element.php index 96f6e9974..432738444 100644 --- a/views/elements/groupfeed_element.php +++ b/views/elements/groupfeed_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * Element responsible for draw the feeds a user is subscribed to * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class GroupfeedElement extends Element implements CrawlConstants { @@ -226,7 +223,7 @@ class GroupfeedElement extends Element implements CrawlConstants * * @param string $paging_query stem for all links * drawn in view - * @param array &$data fields used to draw the queue + * @param array& $data fields used to draw the queue */ function renderGroupedView($paging_query, &$data) { @@ -262,7 +259,7 @@ class GroupfeedElement extends Element implements CrawlConstants * @param string $base_query url that serves as the stem for all links * drawn in view * @param string $paging_query base_query concatenated with limit and num - * @param array &$data fields used to draw the queue + * @param array& $data fields used to draw the queue * @return array $page last feed item processed */ function renderUngroupedView($logged_in, $base_query, $paging_query, &$data) diff --git a/views/elements/help_element.php b/views/elements/help_element.php index 22e05bd02..df168dbb1 100644 --- a/views/elements/help_element.php +++ b/views/elements/help_element.php @@ -1,5 +1,5 @@ <?php -/* +/** * SeekQuarry/Yioop -- * Open Source Pure PHP Search Engine, Crawler, and Indexer * @@ -23,8 +23,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ if (!defined('BASE_DIR')) { * in the AdminView * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class HelpElement extends Element { @@ -111,4 +108,4 @@ class HelpElement extends Element } } } -?> \ No newline at end of file +?> diff --git a/views/elements/language_element.php b/views/elements/language_element.php index bd6f84212..dd0900238 100755 --- a/views/elements/language_element.php +++ b/views/elements/language_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 diff --git a/views/elements/machinelog_element.php b/views/elements/machinelog_element.php index 0c53cb389..3365bb7c1 100644 --- a/views/elements/machinelog_element.php +++ b/views/elements/machinelog_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class MachinelogElement extends Element { diff --git a/views/elements/manageaccount_element.php b/views/elements/manageaccount_element.php index bdfbda0dd..709d53742 100755 --- a/views/elements/manageaccount_element.php +++ b/views/elements/manageaccount_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * that someone can modify for their own SeekQuarry/Yioop account. * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManageaccountElement extends Element { diff --git a/views/elements/manageclassifiers_element.php b/views/elements/manageclassifiers_element.php index 53b8e9c76..f498d5faf 100644 --- a/views/elements/manageclassifiers_element.php +++ b/views/elements/manageclassifiers_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and delete the associated classifier. * * @author Shawn Tice - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManageclassifiersElement extends Element { diff --git a/views/elements/managecrawls_element.php b/views/elements/managecrawls_element.php index 4efecc3c0..bb476f8a8 100755 --- a/views/elements/managecrawls_element.php +++ b/views/elements/managecrawls_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and using a crawl. It makes use of the CrawlStatusView * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManagecrawlsElement extends Element { diff --git a/views/elements/managegroups_element.php b/views/elements/managegroups_element.php index e9cb2fbbd..db4116fa0 100755 --- a/views/elements/managegroups_element.php +++ b/views/elements/managegroups_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Mallika Perepa (Creator), Chris Pollett (rewrote) - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * groups and add and delete users and roles to a group * * @author Mallika Perepa (started) Chris Pollett (rewrite) - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManagegroupsElement extends Element { diff --git a/views/elements/managelocales_element.php b/views/elements/managelocales_element.php index 650ec1354..3e0d2bc6f 100644 --- a/views/elements/managelocales_element.php +++ b/views/elements/managelocales_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * for locales as well as the ability to modify translations within a locale. * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManagelocalesElement extends Element diff --git a/views/elements/managemachines_element.php b/views/elements/managemachines_element.php index 6557df5cc..05f412f47 100644 --- a/views/elements/managemachines_element.php +++ b/views/elements/managemachines_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * call of the MachinestatusView * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManagemachinesElement extends Element { diff --git a/views/elements/manageroles_element.php b/views/elements/manageroles_element.php index 7a35a8f68..cdcac1a6c 100644 --- a/views/elements/manageroles_element.php +++ b/views/elements/manageroles_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * roles and add and delete activitiess from roles * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManagerolesElement extends Element { diff --git a/views/elements/manageusers_element.php b/views/elements/manageusers_element.php index 881523b90..e4a66bec4 100644 --- a/views/elements/manageusers_element.php +++ b/views/elements/manageusers_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * in the AdminView. * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ManageusersElement extends Element { diff --git a/views/elements/mixcrawls_element.php b/views/elements/mixcrawls_element.php index aba7c74c4..227d005ae 100644 --- a/views/elements/mixcrawls_element.php +++ b/views/elements/mixcrawls_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * a crawl mix or edit an existing one * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class MixcrawlsElement extends Element { diff --git a/views/elements/moreoptions_element.php b/views/elements/moreoptions_element.php index 7597f74ea..80ebf798c 100644 --- a/views/elements/moreoptions_element.php +++ b/views/elements/moreoptions_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * search source options, create account, and tool info * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class MoreoptionsElement extends Element { diff --git a/views/elements/pageoptions_element.php b/views/elements/pageoptions_element.php index 3aced1afa..1a728a86c 100644 --- a/views/elements/pageoptions_element.php +++ b/views/elements/pageoptions_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * the recrawl frequency, the file types, etc of the pages crawled * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class PageOptionsElement extends Element { diff --git a/views/elements/resultseditor_element.php b/views/elements/resultseditor_element.php index 470fb4ff5..c5fae1c27 100644 --- a/views/elements/resultseditor_element.php +++ b/views/elements/resultseditor_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ResultsEditorElement extends Element { diff --git a/views/elements/searchsources_element.php b/views/elements/searchsources_element.php index ca47762b1..1a73187bf 100644 --- a/views/elements/searchsources_element.php +++ b/views/elements/searchsources_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * * @author Chris Pollett * - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class SearchsourcesElement extends Element { diff --git a/views/elements/security_element.php b/views/elements/security_element.php index 5eabed8e9..70396d00b 100755 --- a/views/elements/security_element.php +++ b/views/elements/security_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Sreenidhi Muralidharan - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * captchas, and recovery of missing passwords * * @author Sreenidhi Muralidharan/Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class SecurityElement extends Element { @@ -135,4 +132,4 @@ class SecurityElement extends Element } } -?> \ No newline at end of file +?> diff --git a/views/elements/serversettings_element.php b/views/elements/serversettings_element.php index eec3cc8d5..daa5d84e0 100644 --- a/views/elements/serversettings_element.php +++ b/views/elements/serversettings_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * that might be connected with a Yioop installation * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class ServersettingsElement extends Element { diff --git a/views/elements/signin_element.php b/views/elements/signin_element.php index c9ac649a0..8c973688f 100755 --- a/views/elements/signin_element.php +++ b/views/elements/signin_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Element responsible for drawing links to settings and login panels * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class SigninElement extends Element { diff --git a/views/elements/subsearch_element.php b/views/elements/subsearch_element.php index 83e090c6a..176bec272 100644 --- a/views/elements/subsearch_element.php +++ b/views/elements/subsearch_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Element responsible for drawing links to common subsearches * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class SubsearchElement extends Element { diff --git a/views/elements/wiki_element.php b/views/elements/wiki_element.php index ee0abeb6b..9e2afb897 100644 --- a/views/elements/wiki_element.php +++ b/views/elements/wiki_element.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * wiki pages available for a group * * @author Chris Pollett - * @package seek_quarry - * @subpackage element + * @package seek_quarry\view\element */ class WikiElement extends Element implements CrawlConstants { @@ -50,7 +47,7 @@ class WikiElement extends Element implements CrawlConstants * or the edit page form * * @param array $data fields contain data about the page being - * displayeed or edited, or the list of pages being displayed. + * displayed or edited, or the list of pages being displayed. */ function render($data) { @@ -206,8 +203,9 @@ class WikiElement extends Element implements CrawlConstants * @param array $data fields PAGE used for page contents * @param bool $can_edit whether the current user has permissions to * edit or create this page - * @param bool $logged_in whethe current user is logged in or not - */ + * @param bool $logged_in whether current user is logged in or not + * @param bool $is_admin whether or not this is on an admin controller page + */ function renderReadPage($data, $can_edit, $logged_in, $is_admin) { if($is_admin && @@ -264,7 +262,7 @@ class WikiElement extends Element implements CrawlConstants * Used to drawn the form that let's someone edit a wiki page * * @param array $data fields contain data about the page being - * edited. In particular, PAGE contains the raw page data + * edited. In particular, PAGE contains the raw page data */ function renderEditPageForm($data) { @@ -518,12 +516,12 @@ class WikiElement extends Element implements CrawlConstants <?php } /** - * Draws a list of media resources associated with a wiki page + * Draws a list of media resources associated with a wiki page * - * @param array $data fields RESOURCES_INFO contains info on resources - * @param bool $read_mode whether the readering should be for a media + * @param array $data fields RESOURCES_INFO contains info on resources + * @param bool $read_mode whether the readering should be for a media * list in read mode or for use on the edit task of any wiki page - * @param bool $logged_in whether the user is currently logged in or not + * @param bool $logged_in whether the user is currently logged in or not */ function renderResources($data, $read_mode, $logged_in = true) { diff --git a/views/feedstatus_view.php b/views/feedstatus_view.php index 21d3f5c4f..b25ae4abd 100644 --- a/views/feedstatus_view.php +++ b/views/feedstatus_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * crawls that have been made by this seek_quarry instance * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class FeedstatusView extends View { @@ -46,7 +43,7 @@ class FeedstatusView extends View * this view to be instantiated. The renderView method then draws * the most recent feed posts. * - * @param array $data info about the current crawl status + * @param array $data info about the current crawl status */ function renderView($data) { $data["STATUS"] = true; diff --git a/views/fetch_view.php b/views/fetch_view.php index d66be6d16..d3d02e8f6 100755 --- a/views/fetch_view.php +++ b/views/fetch_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * what to crawl next * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class FetchView extends View { diff --git a/views/group_view.php b/views/group_view.php index c17dd6023..5bfee0eec 100644 --- a/views/group_view.php +++ b/views/group_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * group feeds for public feeds when not logged. * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class GroupView extends View implements CrawlConstants { diff --git a/views/helpers/displayresults_helper.php b/views/helpers/displayresults_helper.php index 8de882857..581ca5881 100644 --- a/views/helpers/displayresults_helper.php +++ b/views/helpers/displayresults_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Priya Gangaraju priya.gangaraju@gmail.com - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -42,8 +40,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * otherwise display the data. * * @author Priya Gangaraju - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class DisplayresultsHelper extends Helper { @@ -70,4 +67,4 @@ class DisplayresultsHelper extends Helper } } } -?> \ No newline at end of file +?> diff --git a/views/helpers/feeds_helper.php b/views/helpers/feeds_helper.php index 6877bb8ae..9a64294ad 100644 --- a/views/helpers/feeds_helper.php +++ b/views/helpers/feeds_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * Helper used to draw links and snippets for RSS feeds * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class FeedsHelper extends Helper implements CrawlConstants { diff --git a/views/helpers/filetype_helper.php b/views/helpers/filetype_helper.php index a99770d3f..79f4837ac 100644 --- a/views/helpers/filetype_helper.php +++ b/views/helpers/filetype_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -48,8 +46,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * want to output the latter. * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class FiletypeHelper extends Helper { diff --git a/views/helpers/fileupload_helper.php b/views/helpers/fileupload_helper.php index 554ee6442..fb2aceaf9 100644 --- a/views/helpers/fileupload_helper.php +++ b/views/helpers/fileupload_helper.php @@ -22,9 +22,7 @@ * * END LICENSE * - * @author Chris Pollet chris@pollett.org - * @package seek_quarry - * @subpackage helper + * @author Chris Pollett chris@pollett.org * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR . "/views/helpers/helper.php"; * This helper is used to render a drag and drop file upload region * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class FileUploadHelper extends Helper { @@ -54,19 +51,21 @@ class FileUploadHelper extends Helper parent::__construct(); } /** - * Renders the UI needed to do a drag and file upload + * Renders the UI needed to do a drag and file upload * - * @param string $drop_id the id of the HTMLElement used as a target + * @param string $drop_id the id of the HTMLElement used as a target * for dropping items in - * @param string $form_name the name attribute of the web form input + * @param string $form_name the name attribute of the web form input * element used to handle file uploads - * @param string $elt_id the id attribute of the web form input element + * @param string $elt_id the id attribute of the web form input element * used to handle file uploads - * @param int $max_size the maximum size in bytes of the objects allowed + * @param int $max_size the maximum size in bytes of the objects allowed * to uploaded - * @param string $drop_kind text or image this controls the way the drop + * @param string $drop_kind text or image this controls the way the drop * zone is handled. Image will draw the to-upload image immediately - * @param array $allowed_types what mime types are legal to upload + * @param array $allowed_types what mime types are legal to upload + * @param bool $multiple whether multiple files can be selected when + * file picker used */ public function render($drop_id, $form_name, $elt_id, $max_size, $drop_kind, $allowed_types, $multiple = false) diff --git a/views/helpers/helpbutton_helper.php b/views/helpers/helpbutton_helper.php index ba414efa9..4e2e916bc 100644 --- a/views/helpers/helpbutton_helper.php +++ b/views/helpers/helpbutton_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -41,8 +39,7 @@ require_once BASE_DIR . "/views/helpers/helper.php"; * help. * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class HelpbuttonHelper extends Helper { diff --git a/views/helpers/helper.php b/views/helpers/helper.php index f1722d891..9ac95e14e 100755 --- a/views/helpers/helper.php +++ b/views/helpers/helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * supplied and output HTML/XML * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class Helper { diff --git a/views/helpers/images_helper.php b/views/helpers/images_helper.php index c31546bbe..a23261db1 100644 --- a/views/helpers/images_helper.php +++ b/views/helpers/images_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * Helper used to draw thumbnails strips for images * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class ImagesHelper extends Helper implements CrawlConstants { diff --git a/views/helpers/options_helper.php b/views/helpers/options_helper.php index 1e449d586..da3dc4a31 100755 --- a/views/helpers/options_helper.php +++ b/views/helpers/options_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,12 +38,10 @@ require_once BASE_DIR."/views/helpers/helper.php"; * draw select options form elements * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class OptionsHelper extends Helper { - /** * Draws an HTML select tag according to the supplied parameters * diff --git a/views/helpers/pagination_helper.php b/views/helpers/pagination_helper.php index 708d96fb4..f49aa7868 100755 --- a/views/helpers/pagination_helper.php +++ b/views/helpers/pagination_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * pagination of search results * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class PaginationHelper extends Helper { diff --git a/views/helpers/pagingtable_helper.php b/views/helpers/pagingtable_helper.php index 97938dfb2..b7cdba009 100644 --- a/views/helpers/pagingtable_helper.php +++ b/views/helpers/pagingtable_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -44,8 +42,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * 10, 20, 50, 100, 200 rows at a time. * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class PagingtableHelper extends Helper { diff --git a/views/helpers/searchform_helper.php b/views/helpers/searchform_helper.php index b085d969d..238488358 100644 --- a/views/helpers/searchform_helper.php +++ b/views/helpers/searchform_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * locale, etc folder * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class SearchformHelper extends Helper { @@ -159,4 +156,4 @@ class SearchformHelper extends Helper } } -?> \ No newline at end of file +?> diff --git a/views/helpers/toggle_helper.php b/views/helpers/toggle_helper.php index 86c264690..af4b52edb 100644 --- a/views/helpers/toggle_helper.php +++ b/views/helpers/toggle_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -40,8 +38,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * an On-Off switch in a web page * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class ToggleHelper extends Helper { diff --git a/views/helpers/videourl_helper.php b/views/helpers/videourl_helper.php index ed96b6716..b5ba612c4 100644 --- a/views/helpers/videourl_helper.php +++ b/views/helpers/videourl_helper.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage helper * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/views/helpers/helper.php"; * Helper used to draw thumbnails for video sites * * @author Chris Pollett - * @package seek_quarry - * @subpackage helper + * @package seek_quarry\view\helper */ class VideourlHelper extends Helper { diff --git a/views/layouts/api_layout.php b/views/layouts/api_layout.php index 4bd8a4b11..2934e0d71 100644 --- a/views/layouts/api_layout.php +++ b/views/layouts/api_layout.php @@ -1,6 +1,5 @@ <?php - -/* +/** * SeekQuarry/Yioop -- * Open Source Pure PHP Search Engine, Crawler, and Indexer * @@ -24,40 +23,31 @@ * END LICENSE * * @author Eswara Rajesh Pinapala epinapala@live.com - * @package seek_quarry - * @subpackage element * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 * @filesource */ - -if (!defined('BASE_DIR')) { - echo "BAD REQUEST"; - exit(); -} - +if (!defined('BASE_DIR')) { echo "BAD REQUEST"; exit(); } /** * Layout used for the seek_quarry Website * including pages such as search landing page * and settings page * * @author Eswara Rajesh Pinapala - * @package seek_quarry - * @subpackage layout + * @package seek_quarry\view\layout */ -class ApiLayout extends Layout { - +class ApiLayout extends Layout +{ /** * Responsible for drawing the prefix/suffix (if any for the API response) * * @param array $data an array of data set up by the controller to be * be used in drawing the WebLayout and its View. */ - function render($data) { + function render($data) + { $this->view->renderView($data); } - } - ?> diff --git a/views/layouts/layout.php b/views/layouts/layout.php index c5c2678b8..c1b781e34 100755 --- a/views/layouts/layout.php +++ b/views/layouts/layout.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage layout * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * on which a View lives * * @author Chris Pollett - * @package seek_quarry - * @subpackage layout + * @package seek_quarry\view\layout */ class Layout { diff --git a/views/layouts/rss_layout.php b/views/layouts/rss_layout.php index 96cd74547..13a8f4d0c 100644 --- a/views/layouts/rss_layout.php +++ b/views/layouts/rss_layout.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage layout * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and settings page * * @author Chris Pollett - * @package seek_quarry - * @subpackage layout + * @package seek_quarry\view\layout */ class RssLayout extends Layout { diff --git a/views/layouts/web_layout.php b/views/layouts/web_layout.php index 4190cf4e1..2457cc220 100755 --- a/views/layouts/web_layout.php +++ b/views/layouts/web_layout.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage layout * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and settings page * * @author Chris Pollett - * @package seek_quarry - * @subpackage layout + * @package seek_quarry\view\layout */ class WebLayout extends Layout { diff --git a/views/machinestatus_view.php b/views/machinestatus_view.php index 1d77704ab..272c03403 100644 --- a/views/machinestatus_view.php +++ b/views/machinestatus_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * this instance of Yioop. * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class MachinestatusView extends View { diff --git a/views/nocache_view.php b/views/nocache_view.php index f59ddbb74..ec64c1353 100755 --- a/views/nocache_view.php +++ b/views/nocache_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * no cache is available * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class NocacheView extends View { diff --git a/views/recover_view.php b/views/recover_view.php index aabfec3e9..252d75b2e 100644 --- a/views/recover_view.php +++ b/views/recover_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * screen for recovering a forgotten password * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class RecoverView extends View { diff --git a/views/register_view.php b/views/register_view.php index 6f8ae415a..1da27ff71 100755 --- a/views/register_view.php +++ b/views/register_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * Draws the page that allows a user to register for an account * * @author Mallika Perepa (creator), Chris Pollett, Akash Patel - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class RegisterView extends View { diff --git a/views/rss_view.php b/views/rss_view.php index 50a5e753a..078612c0f 100644 --- a/views/rss_view.php +++ b/views/rss_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * people to types searches into * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class RssView extends View implements CrawlConstants { diff --git a/views/search_view.php b/views/search_view.php index bb5243cfd..14d731f7d 100755 --- a/views/search_view.php +++ b/views/search_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -39,8 +37,7 @@ require_once BASE_DIR."/lib/crawl_constants.php"; * people to types searches into * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class SearchView extends View implements CrawlConstants { diff --git a/views/settings_view.php b/views/settings_view.php index 1ddf5d8d8..0e769cc65 100755 --- a/views/settings_view.php +++ b/views/settings_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -38,8 +36,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * and the language settings * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class SettingsView extends View { diff --git a/views/signin_view.php b/views/signin_view.php index 591776e7e..1a837a89d 100755 --- a/views/signin_view.php +++ b/views/signin_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * screen for the admin panel of the Seek Quarry app * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class SigninView extends View { diff --git a/views/static_view.php b/views/static_view.php index 0b3ee4c18..9972ad50c 100644 --- a/views/static_view.php +++ b/views/static_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -36,8 +34,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * a more static cleaned up way * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class StaticView extends View { diff --git a/views/statistics_view.php b/views/statistics_view.php index ccd00924e..3f5ee95fe 100644 --- a/views/statistics_view.php +++ b/views/statistics_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * file sizes, distribution of file type, distribution of languages, etc * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class StatisticsView extends View { diff --git a/views/suggest_view.php b/views/suggest_view.php index e0bebaf9e..c566fe8df 100644 --- a/views/suggest_view.php +++ b/views/suggest_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -35,8 +33,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * View repsonsible for drawing the form where a user can suggest a URL * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class SuggestView extends View { diff --git a/views/view.php b/views/view.php index 4dd00a5fe..71120cd3f 100644 --- a/views/view.php +++ b/views/view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -45,8 +43,7 @@ require_once BASE_DIR."/views/layouts/layout.php"; * the output of controller activity * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ abstract class View { diff --git a/views/wiki_view.php b/views/wiki_view.php index 936df1f73..a0ad89c70 100644 --- a/views/wiki_view.php +++ b/views/wiki_view.php @@ -23,8 +23,6 @@ * END LICENSE * * @author Chris Pollett chris@pollett.org - * @package seek_quarry - * @subpackage view * @license http://www.gnu.org/licenses/ GPL3 * @link http://www.seekquarry.com/ * @copyright 2009 - 2015 @@ -37,8 +35,7 @@ if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();} * wiki pages for public groups when not logged. * * @author Chris Pollett - * @package seek_quarry - * @subpackage view + * @package seek_quarry\view */ class WikiView extends View { @@ -177,4 +174,4 @@ class WikiView extends View } } } -?> \ No newline at end of file +?>