ggoffy / wggithub

admin/menu.php

Indentation +30 added lines, -30 removed lines

@@ -27,52 +27,52 @@
 $sysPathIcon32 = $moduleInfo->getInfo('sysicons32');
 
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU1,
-	'link' => 'admin/index.php',
-	'icon' => $sysPathIcon32.'/dashboard.png',
+    'title' => _MI_WGGITHUB_ADMENU1,
+    'link' => 'admin/index.php',
+    'icon' => $sysPathIcon32.'/dashboard.png',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU2,
-	'link' => 'admin/settings.php',
-	'icon' => 'assets/icons/32/blank.gif',
+    'title' => _MI_WGGITHUB_ADMENU2,
+    'link' => 'admin/settings.php',
+    'icon' => 'assets/icons/32/blank.gif',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU3,
-	'link' => 'admin/directories.php',
-	'icon' => 'assets/icons/32/blank.gif',
+    'title' => _MI_WGGITHUB_ADMENU3,
+    'link' => 'admin/directories.php',
+    'icon' => 'assets/icons/32/blank.gif',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU4,
-	'link' => 'admin/logs.php',
-	'icon' => 'assets/icons/32/blank.gif',
+    'title' => _MI_WGGITHUB_ADMENU4,
+    'link' => 'admin/logs.php',
+    'icon' => 'assets/icons/32/blank.gif',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU5,
-	'link' => 'admin/repositories.php',
-	'icon' => 'assets/icons/32/blank.gif',
+    'title' => _MI_WGGITHUB_ADMENU5,
+    'link' => 'admin/repositories.php',
+    'icon' => 'assets/icons/32/blank.gif',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU6,
-	'link' => 'admin/readmes.php',
-	'icon' => 'assets/icons/32/addlink.png',
+    'title' => _MI_WGGITHUB_ADMENU6,
+    'link' => 'admin/readmes.php',
+    'icon' => 'assets/icons/32/addlink.png',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU7,
-	'link' => 'admin/releases.php',
-	'icon' => 'assets/icons/32/blank.gif',
+    'title' => _MI_WGGITHUB_ADMENU7,
+    'link' => 'admin/releases.php',
+    'icon' => 'assets/icons/32/blank.gif',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU8,
-	'link' => 'admin/permissions.php',
-	'icon' => $sysPathIcon32.'/permissions.png',
+    'title' => _MI_WGGITHUB_ADMENU8,
+    'link' => 'admin/permissions.php',
+    'icon' => $sysPathIcon32.'/permissions.png',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ADMENU9,
-	'link' => 'admin/feedback.php',
-	'icon' => $sysPathIcon32.'/mail_foward.png',
+    'title' => _MI_WGGITHUB_ADMENU9,
+    'link' => 'admin/feedback.php',
+    'icon' => $sysPathIcon32.'/mail_foward.png',
 ];
 $adminmenu[] = [
-	'title' => _MI_WGGITHUB_ABOUT,
-	'link' => 'admin/about.php',
-	'icon' => $sysPathIcon32.'/about.png',
+    'title' => _MI_WGGITHUB_ABOUT,
+    'link' => 'admin/about.php',
+    'icon' => $sysPathIcon32.'/about.png',
 ];

admin/logs.php

Indentation +101 added lines, -101 removed lines

@@ -31,107 +31,107 @@
 // Request log_id
 $logId = Request::getInt('log_id');
 switch ($op) {
-	case 'list':
-	default:
-		// Define Stylesheet
-		$GLOBALS['xoTheme']->addStylesheet($style, null);
-		$start = Request::getInt('start', 0);
-		$limit = Request::getInt('limit', $helper->getConfig('adminpager'));
-		$templateMain = 'wggithub_admin_logs.tpl';
-		$GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
-		$adminObject->addItemButton(_AM_WGGITHUB_ADD_LOG, 'logs.php?op=new', 'add');
-		$GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
-		$logsCount = $logsHandler->getCountLogs();
-		$logsAll = $logsHandler->getAllLogs($start, $limit);
-		$GLOBALS['xoopsTpl']->assign('logs_count', $logsCount);
-		$GLOBALS['xoopsTpl']->assign('wggithub_url', WGGITHUB_URL);
-		$GLOBALS['xoopsTpl']->assign('wggithub_upload_url', WGGITHUB_UPLOAD_URL);
-		// Table view logs
-		if ($logsCount > 0) {
-			foreach (\array_keys($logsAll) as $i) {
-				$log = $logsAll[$i]->getValuesLogs();
-				$GLOBALS['xoopsTpl']->append('logs_list', $log);
-				unset($log);
-			}
-			// Display Navigation
-			if ($logsCount > $limit) {
-				include_once XOOPS_ROOT_PATH . '/class/pagenav.php';
-				$pagenav = new \XoopsPageNav($logsCount, $limit, $start, 'start', 'op=list&limit=' . $limit);
-				$GLOBALS['xoopsTpl']->assign('pagenav', $pagenav->renderNav(4));
-			}
-		} else {
-			$GLOBALS['xoopsTpl']->assign('error', _AM_WGGITHUB_THEREARENT_LOGS);
-		}
-		break;
-	case 'new':
-		$templateMain = 'wggithub_admin_logs.tpl';
-		$GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
-		$adminObject->addItemButton(_AM_WGGITHUB_LOGS_LIST, 'logs.php', 'list');
-		$GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
-		// Form Create
-		$logsObj = $logsHandler->create();
-		$form = $logsObj->getFormLogs();
-		$GLOBALS['xoopsTpl']->assign('form', $form->render());
-		break;
-	case 'save':
-		// Security Check
-		if (!$GLOBALS['xoopsSecurity']->check()) {
-			\redirect_header('logs.php', 3, \implode(',', $GLOBALS['xoopsSecurity']->getErrors()));
-		}
-		if ($logId > 0) {
-			$logsObj = $logsHandler->get($logId);
-		} else {
-			$logsObj = $logsHandler->create();
-		}
-		// Set Vars
+    case 'list':
+    default:
+        // Define Stylesheet
+        $GLOBALS['xoTheme']->addStylesheet($style, null);
+        $start = Request::getInt('start', 0);
+        $limit = Request::getInt('limit', $helper->getConfig('adminpager'));
+        $templateMain = 'wggithub_admin_logs.tpl';
+        $GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
+        $adminObject->addItemButton(_AM_WGGITHUB_ADD_LOG, 'logs.php?op=new', 'add');
+        $GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
+        $logsCount = $logsHandler->getCountLogs();
+        $logsAll = $logsHandler->getAllLogs($start, $limit);
+        $GLOBALS['xoopsTpl']->assign('logs_count', $logsCount);
+        $GLOBALS['xoopsTpl']->assign('wggithub_url', WGGITHUB_URL);
+        $GLOBALS['xoopsTpl']->assign('wggithub_upload_url', WGGITHUB_UPLOAD_URL);
+        // Table view logs
+        if ($logsCount > 0) {
+            foreach (\array_keys($logsAll) as $i) {
+                $log = $logsAll[$i]->getValuesLogs();
+                $GLOBALS['xoopsTpl']->append('logs_list', $log);
+                unset($log);
+            }
+            // Display Navigation
+            if ($logsCount > $limit) {
+                include_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+                $pagenav = new \XoopsPageNav($logsCount, $limit, $start, 'start', 'op=list&limit=' . $limit);
+                $GLOBALS['xoopsTpl']->assign('pagenav', $pagenav->renderNav(4));
+            }
+        } else {
+            $GLOBALS['xoopsTpl']->assign('error', _AM_WGGITHUB_THEREARENT_LOGS);
+        }
+        break;
+    case 'new':
+        $templateMain = 'wggithub_admin_logs.tpl';
+        $GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
+        $adminObject->addItemButton(_AM_WGGITHUB_LOGS_LIST, 'logs.php', 'list');
+        $GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
+        // Form Create
+        $logsObj = $logsHandler->create();
+        $form = $logsObj->getFormLogs();
+        $GLOBALS['xoopsTpl']->assign('form', $form->render());
+        break;
+    case 'save':
+        // Security Check
+        if (!$GLOBALS['xoopsSecurity']->check()) {
+            \redirect_header('logs.php', 3, \implode(',', $GLOBALS['xoopsSecurity']->getErrors()));
+        }
+        if ($logId > 0) {
+            $logsObj = $logsHandler->get($logId);
+        } else {
+            $logsObj = $logsHandler->create();
+        }
+        // Set Vars
         $logsObj->setVar('log_type', Request::getInt('log_type', 0));
-		$logsObj->setVar('log_details', Request::getString('log_details', ''));
-		$logsObj->setVar('log_result', Request::getString('log_result', ''));
-		$logDatecreatedObj = \DateTime::createFromFormat(_SHORTDATESTRING, Request::getString('log_datecreated'));
-		$logsObj->setVar('log_datecreated', $logDatecreatedObj->getTimestamp());
-		$logsObj->setVar('log_submitter', Request::getInt('log_submitter', 0));
-		// Insert Data
-		if ($logsHandler->insert($logsObj)) {
-			\redirect_header('logs.php?op=list', 2, _AM_WGGITHUB_FORM_OK);
-		}
-		// Get Form
-		$GLOBALS['xoopsTpl']->assign('error', $logsObj->getHtmlErrors());
-		$form = $logsObj->getFormLogs();
-		$GLOBALS['xoopsTpl']->assign('form', $form->render());
-		break;
-	case 'edit':
-		$templateMain = 'wggithub_admin_logs.tpl';
-		$GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
-		$adminObject->addItemButton(_AM_WGGITHUB_ADD_LOG, 'logs.php?op=new', 'add');
-		$adminObject->addItemButton(_AM_WGGITHUB_LOGS_LIST, 'logs.php', 'list');
-		$GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
-		// Get Form
-		$logsObj = $logsHandler->get($logId);
-		$form = $logsObj->getFormLogs();
-		$GLOBALS['xoopsTpl']->assign('form', $form->render());
-		break;
-	case 'delete':
-		$templateMain = 'wggithub_admin_logs.tpl';
-		$GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
-		$logsObj = $logsHandler->get($logId);
-		$reqRequest = $logsObj->getVar('log_details');
-		if (isset($_REQUEST['ok']) && 1 == $_REQUEST['ok']) {
-			if (!$GLOBALS['xoopsSecurity']->check()) {
-				\redirect_header('logs.php', 3, \implode(', ', $GLOBALS['xoopsSecurity']->getErrors()));
-			}
-			if ($logsHandler->delete($logsObj)) {
-				\redirect_header('logs.php', 3, _AM_WGGITHUB_FORM_DELETE_OK);
-			} else {
-				$GLOBALS['xoopsTpl']->assign('error', $logsObj->getHtmlErrors());
-			}
-		} else {
-			$xoopsconfirm = new Common\XoopsConfirm(
-				['ok' => 1, 'log_id' => $logId, 'op' => 'delete'],
-				$_SERVER['REQUEST_URI'],
-				\sprintf(_AM_WGGITHUB_FORM_SURE_DELETE, $logsObj->getVar('log_details')));
-			$form = $xoopsconfirm->getFormXoopsConfirm();
-			$GLOBALS['xoopsTpl']->assign('form', $form->render());
-		}
-		break;
+        $logsObj->setVar('log_details', Request::getString('log_details', ''));
+        $logsObj->setVar('log_result', Request::getString('log_result', ''));
+        $logDatecreatedObj = \DateTime::createFromFormat(_SHORTDATESTRING, Request::getString('log_datecreated'));
+        $logsObj->setVar('log_datecreated', $logDatecreatedObj->getTimestamp());
+        $logsObj->setVar('log_submitter', Request::getInt('log_submitter', 0));
+        // Insert Data
+        if ($logsHandler->insert($logsObj)) {
+            \redirect_header('logs.php?op=list', 2, _AM_WGGITHUB_FORM_OK);
+        }
+        // Get Form
+        $GLOBALS['xoopsTpl']->assign('error', $logsObj->getHtmlErrors());
+        $form = $logsObj->getFormLogs();
+        $GLOBALS['xoopsTpl']->assign('form', $form->render());
+        break;
+    case 'edit':
+        $templateMain = 'wggithub_admin_logs.tpl';
+        $GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
+        $adminObject->addItemButton(_AM_WGGITHUB_ADD_LOG, 'logs.php?op=new', 'add');
+        $adminObject->addItemButton(_AM_WGGITHUB_LOGS_LIST, 'logs.php', 'list');
+        $GLOBALS['xoopsTpl']->assign('buttons', $adminObject->displayButton('left'));
+        // Get Form
+        $logsObj = $logsHandler->get($logId);
+        $form = $logsObj->getFormLogs();
+        $GLOBALS['xoopsTpl']->assign('form', $form->render());
+        break;
+    case 'delete':
+        $templateMain = 'wggithub_admin_logs.tpl';
+        $GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation('logs.php'));
+        $logsObj = $logsHandler->get($logId);
+        $reqRequest = $logsObj->getVar('log_details');
+        if (isset($_REQUEST['ok']) && 1 == $_REQUEST['ok']) {
+            if (!$GLOBALS['xoopsSecurity']->check()) {
+                \redirect_header('logs.php', 3, \implode(', ', $GLOBALS['xoopsSecurity']->getErrors()));
+            }
+            if ($logsHandler->delete($logsObj)) {
+                \redirect_header('logs.php', 3, _AM_WGGITHUB_FORM_DELETE_OK);
+            } else {
+                $GLOBALS['xoopsTpl']->assign('error', $logsObj->getHtmlErrors());
+            }
+        } else {
+            $xoopsconfirm = new Common\XoopsConfirm(
+                ['ok' => 1, 'log_id' => $logId, 'op' => 'delete'],
+                $_SERVER['REQUEST_URI'],
+                \sprintf(_AM_WGGITHUB_FORM_SURE_DELETE, $logsObj->getVar('log_details')));
+            $form = $xoopsconfirm->getFormXoopsConfirm();
+            $GLOBALS['xoopsTpl']->assign('form', $form->render());
+        }
+        break;
 }
 require __DIR__ . '/footer.php';

xoops_version.php

Indentation +224 added lines, -224 removed lines

@@ -25,208 +25,208 @@ 
 $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
 // ------------------- Informations ------------------- //
 $modversion = [
-	'name'                => _MI_WGGITHUB_NAME,
-	'version'             => 1.01,
-	'description'         => _MI_WGGITHUB_DESC,
-	'author'              => 'Goffy - XOOPS Development Team',
-	'author_mail'         => 'goffy@wedega.com',
-	'author_website_url'  => 'https://wedega.com',
-	'author_website_name' => 'XOOPS on Wedega',
-	'credits'             => 'Goffy - XOOPS Development Team',
-	'license'             => 'GPL 2.0 or later',
-	'license_url'         => 'http://www.gnu.org/licenses/gpl-3.0.en.html',
-	'help'                => 'page=help',
-	'release_info'        => 'release_info',
-	'release_file'        => XOOPS_URL . '/modules/wggithub/docs/release_info file',
-	'release_date'        => '2020/11/21',
-	'manual'              => 'link to manual file',
-	'manual_file'         => XOOPS_URL . '/modules/wggithub/docs/install.txt',
-	'min_php'             => '7.2',
-	'min_xoops'           => '2.5.10',
-	'min_admin'           => '1.2',
-	'min_db'              => ['mysql' => '5.6', 'mysqli' => '5.6'],
-	'image'               => 'assets/images/logoModule.png',
-	'dirname'             => \basename(__DIR__),
-	'dirmoduleadmin'      => 'Frameworks/moduleclasses/moduleadmin',
-	'sysicons16'          => '../../Frameworks/moduleclasses/icons/16',
-	'sysicons32'          => '../../Frameworks/moduleclasses/icons/32',
-	'modicons16'          => 'assets/icons/16',
-	'modicons32'          => 'assets/icons/32',
-	'demo_site_url'       => 'https://xoops.org',
-	'demo_site_name'      => 'XOOPS Demo Site',
-	'support_url'         => 'https://xoops.org/modules/newbb',
-	'support_name'        => 'Support Forum',
-	'module_website_url'  => 'www.xoops.org',
-	'module_website_name' => 'XOOPS Project',
-	'release'             => '2017-12-02',
-	'module_status'       => 'Beta 1',
-	'system_menu'         => 1,
-	'hasAdmin'            => 1,
-	'hasMain'             => 1,
-	'adminindex'          => 'admin/index.php',
-	'adminmenu'           => 'admin/menu.php',
-	'onInstall'           => 'include/install.php',
-	'onUninstall'         => 'include/uninstall.php',
-	'onUpdate'            => 'include/update.php',
+    'name'                => _MI_WGGITHUB_NAME,
+    'version'             => 1.01,
+    'description'         => _MI_WGGITHUB_DESC,
+    'author'              => 'Goffy - XOOPS Development Team',
+    'author_mail'         => 'goffy@wedega.com',
+    'author_website_url'  => 'https://wedega.com',
+    'author_website_name' => 'XOOPS on Wedega',
+    'credits'             => 'Goffy - XOOPS Development Team',
+    'license'             => 'GPL 2.0 or later',
+    'license_url'         => 'http://www.gnu.org/licenses/gpl-3.0.en.html',
+    'help'                => 'page=help',
+    'release_info'        => 'release_info',
+    'release_file'        => XOOPS_URL . '/modules/wggithub/docs/release_info file',
+    'release_date'        => '2020/11/21',
+    'manual'              => 'link to manual file',
+    'manual_file'         => XOOPS_URL . '/modules/wggithub/docs/install.txt',
+    'min_php'             => '7.2',
+    'min_xoops'           => '2.5.10',
+    'min_admin'           => '1.2',
+    'min_db'              => ['mysql' => '5.6', 'mysqli' => '5.6'],
+    'image'               => 'assets/images/logoModule.png',
+    'dirname'             => \basename(__DIR__),
+    'dirmoduleadmin'      => 'Frameworks/moduleclasses/moduleadmin',
+    'sysicons16'          => '../../Frameworks/moduleclasses/icons/16',
+    'sysicons32'          => '../../Frameworks/moduleclasses/icons/32',
+    'modicons16'          => 'assets/icons/16',
+    'modicons32'          => 'assets/icons/32',
+    'demo_site_url'       => 'https://xoops.org',
+    'demo_site_name'      => 'XOOPS Demo Site',
+    'support_url'         => 'https://xoops.org/modules/newbb',
+    'support_name'        => 'Support Forum',
+    'module_website_url'  => 'www.xoops.org',
+    'module_website_name' => 'XOOPS Project',
+    'release'             => '2017-12-02',
+    'module_status'       => 'Beta 1',
+    'system_menu'         => 1,
+    'hasAdmin'            => 1,
+    'hasMain'             => 1,
+    'adminindex'          => 'admin/index.php',
+    'adminmenu'           => 'admin/menu.php',
+    'onInstall'           => 'include/install.php',
+    'onUninstall'         => 'include/uninstall.php',
+    'onUpdate'            => 'include/update.php',
 ];
 // ------------------- Templates ------------------- //
 $modversion['templates'] = [
-	// Admin templates
-	['file' => 'wggithub_admin_about.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_header.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_index.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_settings.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_repositories.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_directories.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_logs.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_readmes.tpl', 'description' => '', 'type' => 'admin'],
+    // Admin templates
+    ['file' => 'wggithub_admin_about.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_header.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_index.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_settings.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_repositories.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_directories.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_logs.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_readmes.tpl', 'description' => '', 'type' => 'admin'],
     ['file' => 'wggithub_admin_releases.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_permissions.tpl', 'description' => '', 'type' => 'admin'],
-	['file' => 'wggithub_admin_footer.tpl', 'description' => '', 'type' => 'admin'],
-	// User templates
-	['file' => 'wggithub_header.tpl', 'description' => ''],
-	['file' => 'wggithub_index.tpl', 'description' => ''],
-	['file' => 'wggithub_repositories.tpl', 'description' => ''],
-	['file' => 'wggithub_repositories_list.tpl', 'description' => ''],
-	['file' => 'wggithub_repositories_item.tpl', 'description' => ''],
-	['file' => 'wggithub_directories.tpl', 'description' => ''],
-	['file' => 'wggithub_directories_list.tpl', 'description' => ''],
-	['file' => 'wggithub_directories_item.tpl', 'description' => ''],
-	['file' => 'wggithub_readmes.tpl', 'description' => ''],
-	['file' => 'wggithub_readmes_list.tpl', 'description' => ''],
-	['file' => 'wggithub_readmes_item.tpl', 'description' => ''],
-	['file' => 'wggithub_breadcrumbs.tpl', 'description' => ''],
-	['file' => 'wggithub_search.tpl', 'description' => ''],
-	['file' => 'wggithub_footer.tpl', 'description' => ''],
+    ['file' => 'wggithub_admin_permissions.tpl', 'description' => '', 'type' => 'admin'],
+    ['file' => 'wggithub_admin_footer.tpl', 'description' => '', 'type' => 'admin'],
+    // User templates
+    ['file' => 'wggithub_header.tpl', 'description' => ''],
+    ['file' => 'wggithub_index.tpl', 'description' => ''],
+    ['file' => 'wggithub_repositories.tpl', 'description' => ''],
+    ['file' => 'wggithub_repositories_list.tpl', 'description' => ''],
+    ['file' => 'wggithub_repositories_item.tpl', 'description' => ''],
+    ['file' => 'wggithub_directories.tpl', 'description' => ''],
+    ['file' => 'wggithub_directories_list.tpl', 'description' => ''],
+    ['file' => 'wggithub_directories_item.tpl', 'description' => ''],
+    ['file' => 'wggithub_readmes.tpl', 'description' => ''],
+    ['file' => 'wggithub_readmes_list.tpl', 'description' => ''],
+    ['file' => 'wggithub_readmes_item.tpl', 'description' => ''],
+    ['file' => 'wggithub_breadcrumbs.tpl', 'description' => ''],
+    ['file' => 'wggithub_search.tpl', 'description' => ''],
+    ['file' => 'wggithub_footer.tpl', 'description' => ''],
 ];
 // ------------------- Mysql ------------------- //
 $modversion['sqlfile']['mysql'] = 'sql/mysql.sql';
 // Tables
 $modversion['tables'] = [
-	'wggithub_settings',
-	'wggithub_repositories',
-	'wggithub_directories',
-	'wggithub_logs',
-	'wggithub_readmes',
+    'wggithub_settings',
+    'wggithub_repositories',
+    'wggithub_directories',
+    'wggithub_logs',
+    'wggithub_readmes',
     'wggithub_releases',
 ];
 // ------------------- Search ------------------- //
 $modversion['hasSearch'] = 1;
 $modversion['search'] = [
-	'file' => 'include/search.inc.php',
-	'func' => 'wggithub_search',
+    'file' => 'include/search.inc.php',
+    'func' => 'wggithub_search',
 ];
 // ------------------- Blocks ------------------- //
 // Repositories last
 $modversion['blocks'][] = [
-	'file'        => 'repositories.php',
-	'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_LAST,
-	'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_LAST_DESC,
-	'show_func'   => 'b_wggithub_repositories_show',
-	'edit_func'   => 'b_wggithub_repositories_edit',
-	'template'    => 'wggithub_block_repositories.tpl',
-	'options'     => 'last|5|25|0',
+    'file'        => 'repositories.php',
+    'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_LAST,
+    'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_LAST_DESC,
+    'show_func'   => 'b_wggithub_repositories_show',
+    'edit_func'   => 'b_wggithub_repositories_edit',
+    'template'    => 'wggithub_block_repositories.tpl',
+    'options'     => 'last|5|25|0',
 ];
 // Repositories new
 $modversion['blocks'][] = [
-	'file'        => 'repositories.php',
-	'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_NEW,
-	'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_NEW_DESC,
-	'show_func'   => 'b_wggithub_repositories_show',
-	'edit_func'   => 'b_wggithub_repositories_edit',
-	'template'    => 'wggithub_block_repositories.tpl',
-	'options'     => 'new|5|25|0',
+    'file'        => 'repositories.php',
+    'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_NEW,
+    'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_NEW_DESC,
+    'show_func'   => 'b_wggithub_repositories_show',
+    'edit_func'   => 'b_wggithub_repositories_edit',
+    'template'    => 'wggithub_block_repositories.tpl',
+    'options'     => 'new|5|25|0',
 ];
 // Repositories hits
 $modversion['blocks'][] = [
-	'file'        => 'repositories.php',
-	'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_HITS,
-	'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_HITS_DESC,
-	'show_func'   => 'b_wggithub_repositories_show',
-	'edit_func'   => 'b_wggithub_repositories_edit',
-	'template'    => 'wggithub_block_repositories.tpl',
-	'options'     => 'hits|5|25|0',
+    'file'        => 'repositories.php',
+    'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_HITS,
+    'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_HITS_DESC,
+    'show_func'   => 'b_wggithub_repositories_show',
+    'edit_func'   => 'b_wggithub_repositories_edit',
+    'template'    => 'wggithub_block_repositories.tpl',
+    'options'     => 'hits|5|25|0',
 ];
 // Repositories top
 $modversion['blocks'][] = [
-	'file'        => 'repositories.php',
-	'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_TOP,
-	'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_TOP_DESC,
-	'show_func'   => 'b_wggithub_repositories_show',
-	'edit_func'   => 'b_wggithub_repositories_edit',
-	'template'    => 'wggithub_block_repositories.tpl',
-	'options'     => 'top|5|25|0',
+    'file'        => 'repositories.php',
+    'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_TOP,
+    'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_TOP_DESC,
+    'show_func'   => 'b_wggithub_repositories_show',
+    'edit_func'   => 'b_wggithub_repositories_edit',
+    'template'    => 'wggithub_block_repositories.tpl',
+    'options'     => 'top|5|25|0',
 ];
 // Repositories random
 $modversion['blocks'][] = [
-	'file'        => 'repositories.php',
-	'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_RANDOM,
-	'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_RANDOM_DESC,
-	'show_func'   => 'b_wggithub_repositories_show',
-	'edit_func'   => 'b_wggithub_repositories_edit',
-	'template'    => 'wggithub_block_repositories.tpl',
-	'options'     => 'random|5|25|0',
+    'file'        => 'repositories.php',
+    'name'        => _MI_WGGITHUB_REPOSITORIES_BLOCK_RANDOM,
+    'description' => _MI_WGGITHUB_REPOSITORIES_BLOCK_RANDOM_DESC,
+    'show_func'   => 'b_wggithub_repositories_show',
+    'edit_func'   => 'b_wggithub_repositories_edit',
+    'template'    => 'wggithub_block_repositories.tpl',
+    'options'     => 'random|5|25|0',
 ];
 // ------------------- Config ------------------- //
 // Editor Admin
 \xoops_load('xoopseditorhandler');
 $editorHandler = XoopsEditorHandler::getInstance();
 $modversion['config'][] = [
-	'name'        => 'editor_admin',
-	'title'       => '_MI_WGGITHUB_EDITOR_ADMIN',
-	'description' => '_MI_WGGITHUB_EDITOR_ADMIN_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'text',
-	'default'     => 'dhtml',
-	'options'     => array_flip($editorHandler->getList()),
+    'name'        => 'editor_admin',
+    'title'       => '_MI_WGGITHUB_EDITOR_ADMIN',
+    'description' => '_MI_WGGITHUB_EDITOR_ADMIN_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'text',
+    'default'     => 'dhtml',
+    'options'     => array_flip($editorHandler->getList()),
 ];
 // Editor User
 \xoops_load('xoopseditorhandler');
 $editorHandler = XoopsEditorHandler::getInstance();
 $modversion['config'][] = [
-	'name'        => 'editor_user',
-	'title'       => '_MI_WGGITHUB_EDITOR_USER',
-	'description' => '_MI_WGGITHUB_EDITOR_USER_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'text',
-	'default'     => 'dhtml',
-	'options'     => array_flip($editorHandler->getList()),
+    'name'        => 'editor_user',
+    'title'       => '_MI_WGGITHUB_EDITOR_USER',
+    'description' => '_MI_WGGITHUB_EDITOR_USER_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'text',
+    'default'     => 'dhtml',
+    'options'     => array_flip($editorHandler->getList()),
 ];
 // Editor : max characters admin area
 $modversion['config'][] = [
-	'name'        => 'editor_maxchar',
-	'title'       => '_MI_WGGITHUB_EDITOR_MAXCHAR',
-	'description' => '_MI_WGGITHUB_EDITOR_MAXCHAR_DESC',
-	'formtype'    => 'textbox',
-	'valuetype'   => 'int',
-	'default'     => 50,
+    'name'        => 'editor_maxchar',
+    'title'       => '_MI_WGGITHUB_EDITOR_MAXCHAR',
+    'description' => '_MI_WGGITHUB_EDITOR_MAXCHAR_DESC',
+    'formtype'    => 'textbox',
+    'valuetype'   => 'int',
+    'default'     => 50,
 ];
 // Get groups
 $memberHandler = \xoops_getHandler('member');
 $xoopsGroups  = $memberHandler->getGroupList();
 $groups = [];
 foreach ($xoopsGroups as $key => $group) {
-	$groups[$group]  = $key;
+    $groups[$group]  = $key;
 }
 // General access groups
 $modversion['config'][] = [
-	'name'        => 'groups',
-	'title'       => '_MI_WGGITHUB_GROUPS',
-	'description' => '_MI_WGGITHUB_GROUPS_DESC',
-	'formtype'    => 'select_multi',
-	'valuetype'   => 'array',
-	'default'     => $groups,
-	'options'     => $groups,
+    'name'        => 'groups',
+    'title'       => '_MI_WGGITHUB_GROUPS',
+    'description' => '_MI_WGGITHUB_GROUPS_DESC',
+    'formtype'    => 'select_multi',
+    'valuetype'   => 'array',
+    'default'     => $groups,
+    'options'     => $groups,
 ];
 // Upload groups
 $modversion['config'][] = [
-	'name'        => 'upload_groups',
-	'title'       => '_MI_WGGITHUB_UPLOAD_GROUPS',
-	'description' => '_MI_WGGITHUB_UPLOAD_GROUPS_DESC',
-	'formtype'    => 'select_multi',
-	'valuetype'   => 'array',
-	'default'     => $groups,
-	'options'     => $groups,
+    'name'        => 'upload_groups',
+    'title'       => '_MI_WGGITHUB_UPLOAD_GROUPS',
+    'description' => '_MI_WGGITHUB_UPLOAD_GROUPS_DESC',
+    'formtype'    => 'select_multi',
+    'valuetype'   => 'array',
+    'default'     => $groups,
+    'options'     => $groups,
 ];
 // Get Admin groups
 $crGroups = new \CriteriaCompo();
@@ -235,118 +235,118 @@ 
 $adminXoopsGroups  = $memberHandler->getGroupList($crGroups);
 $adminGroups = [];
 foreach ($adminXoopsGroups as $key => $adminGroup) {
-	$adminGroups[$adminGroup]  = $key;
+    $adminGroups[$adminGroup]  = $key;
 }
 $modversion['config'][] = [
-	'name'        => 'admin_groups',
-	'title'       => '_MI_WGGITHUB_ADMIN_GROUPS',
-	'description' => '_MI_WGGITHUB_ADMIN_GROUPS_DESC',
-	'formtype'    => 'select_multi',
-	'valuetype'   => 'array',
-	'default'     => $adminGroups,
-	'options'     => $adminGroups,
+    'name'        => 'admin_groups',
+    'title'       => '_MI_WGGITHUB_ADMIN_GROUPS',
+    'description' => '_MI_WGGITHUB_ADMIN_GROUPS_DESC',
+    'formtype'    => 'select_multi',
+    'valuetype'   => 'array',
+    'default'     => $adminGroups,
+    'options'     => $adminGroups,
 ];
 unset($crGroups);
 // Keywords
 $modversion['config'][] = [
-	'name'        => 'keywords',
-	'title'       => '_MI_WGGITHUB_KEYWORDS',
-	'description' => '_MI_WGGITHUB_KEYWORDS_DESC',
-	'formtype'    => 'textbox',
-	'valuetype'   => 'text',
-	'default'     => 'wggithub, settings, repositories, directories, requests, readmes',
+    'name'        => 'keywords',
+    'title'       => '_MI_WGGITHUB_KEYWORDS',
+    'description' => '_MI_WGGITHUB_KEYWORDS_DESC',
+    'formtype'    => 'textbox',
+    'valuetype'   => 'text',
+    'default'     => 'wggithub, settings, repositories, directories, requests, readmes',
 ];
 // Admin pager
 $modversion['config'][] = [
-	'name'        => 'adminpager',
-	'title'       => '_MI_WGGITHUB_ADMIN_PAGER',
-	'description' => '_MI_WGGITHUB_ADMIN_PAGER_DESC',
-	'formtype'    => 'textbox',
-	'valuetype'   => 'int',
-	'default'     => 25,
+    'name'        => 'adminpager',
+    'title'       => '_MI_WGGITHUB_ADMIN_PAGER',
+    'description' => '_MI_WGGITHUB_ADMIN_PAGER_DESC',
+    'formtype'    => 'textbox',
+    'valuetype'   => 'int',
+    'default'     => 25,
 ];
 // User pager
 $modversion['config'][] = [
-	'name'        => 'userpager',
-	'title'       => '_MI_WGGITHUB_USER_PAGER',
-	'description' => '_MI_WGGITHUB_USER_PAGER_DESC',
-	'formtype'    => 'textbox',
-	'valuetype'   => 'int',
-	'default'     => 25,
+    'name'        => 'userpager',
+    'title'       => '_MI_WGGITHUB_USER_PAGER',
+    'description' => '_MI_WGGITHUB_USER_PAGER_DESC',
+    'formtype'    => 'textbox',
+    'valuetype'   => 'int',
+    'default'     => 25,
 ];
 // Number column
 $modversion['config'][] = [
-	'name'        => 'numb_col',
-	'title'       => '_MI_WGGITHUB_NUMB_COL',
-	'description' => '_MI_WGGITHUB_NUMB_COL_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'int',
-	'default'     => 1,
-	'options'     => [1 => '1', 2 => '2', 3 => '3', 4 => '4'],
+    'name'        => 'numb_col',
+    'title'       => '_MI_WGGITHUB_NUMB_COL',
+    'description' => '_MI_WGGITHUB_NUMB_COL_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'int',
+    'default'     => 1,
+    'options'     => [1 => '1', 2 => '2', 3 => '3', 4 => '4'],
 ];
 // Divide by
 $modversion['config'][] = [
-	'name'        => 'divideby',
-	'title'       => '_MI_WGGITHUB_DIVIDEBY',
-	'description' => '_MI_WGGITHUB_DIVIDEBY_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'int',
-	'default'     => 1,
-	'options'     => [1 => '1', 2 => '2', 3 => '3', 4 => '4'],
+    'name'        => 'divideby',
+    'title'       => '_MI_WGGITHUB_DIVIDEBY',
+    'description' => '_MI_WGGITHUB_DIVIDEBY_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'int',
+    'default'     => 1,
+    'options'     => [1 => '1', 2 => '2', 3 => '3', 4 => '4'],
 ];
 // Table type
 $modversion['config'][] = [
-	'name'        => 'table_type',
-	'title'       => '_MI_WGGITHUB_TABLE_TYPE',
-	'description' => '_MI_WGGITHUB_DIVIDEBY_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'int',
-	'default'     => 'bordered',
-	'options'     => ['bordered' => 'bordered', 'striped' => 'striped', 'hover' => 'hover', 'condensed' => 'condensed'],
+    'name'        => 'table_type',
+    'title'       => '_MI_WGGITHUB_TABLE_TYPE',
+    'description' => '_MI_WGGITHUB_DIVIDEBY_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'int',
+    'default'     => 'bordered',
+    'options'     => ['bordered' => 'bordered', 'striped' => 'striped', 'hover' => 'hover', 'condensed' => 'condensed'],
 ];
 // Panel by
 $modversion['config'][] = [
-	'name'        => 'panel_type',
-	'title'       => '_MI_WGGITHUB_PANEL_TYPE',
-	'description' => '_MI_WGGITHUB_PANEL_TYPE_DESC',
-	'formtype'    => 'select',
-	'valuetype'   => 'text',
-	'default'     => 'default',
-	'options'     => ['default' => 'default', 'primary' => 'primary', 'success' => 'success', 'info' => 'info', 'warning' => 'warning', 'danger' => 'danger'],
+    'name'        => 'panel_type',
+    'title'       => '_MI_WGGITHUB_PANEL_TYPE',
+    'description' => '_MI_WGGITHUB_PANEL_TYPE_DESC',
+    'formtype'    => 'select',
+    'valuetype'   => 'text',
+    'default'     => 'default',
+    'options'     => ['default' => 'default', 'primary' => 'primary', 'success' => 'success', 'info' => 'info', 'warning' => 'warning', 'danger' => 'danger'],
 ];
 // Advertise
 $modversion['config'][] = [
-	'name'        => 'advertise',
-	'title'       => '_MI_WGGITHUB_ADVERTISE',
-	'description' => '_MI_WGGITHUB_ADVERTISE_DESC',
-	'formtype'    => 'textarea',
-	'valuetype'   => 'text',
-	'default'     => '',
+    'name'        => 'advertise',
+    'title'       => '_MI_WGGITHUB_ADVERTISE',
+    'description' => '_MI_WGGITHUB_ADVERTISE_DESC',
+    'formtype'    => 'textarea',
+    'valuetype'   => 'text',
+    'default'     => '',
 ];
 // Bookmarks
 $modversion['config'][] = [
-	'name'        => 'bookmarks',
-	'title'       => '_MI_WGGITHUB_BOOKMARKS',
-	'description' => '_MI_WGGITHUB_BOOKMARKS_DESC',
-	'formtype'    => 'yesno',
-	'valuetype'   => 'int',
-	'default'     => 0,
+    'name'        => 'bookmarks',
+    'title'       => '_MI_WGGITHUB_BOOKMARKS',
+    'description' => '_MI_WGGITHUB_BOOKMARKS_DESC',
+    'formtype'    => 'yesno',
+    'valuetype'   => 'int',
+    'default'     => 0,
 ];
 // Make Sample button visible?
 $modversion['config'][] = [
-	'name'        => 'displaySampleButton',
-	'title'       => 'CO_' . $moduleDirNameUpper . '_' . 'SHOW_SAMPLE_BUTTON',
-	'description' => 'CO_' . $moduleDirNameUpper . '_' . 'SHOW_SAMPLE_BUTTON_DESC',
-	'formtype'    => 'yesno',
-	'valuetype'   => 'int',
-	'default'     => 1,
+    'name'        => 'displaySampleButton',
+    'title'       => 'CO_' . $moduleDirNameUpper . '_' . 'SHOW_SAMPLE_BUTTON',
+    'description' => 'CO_' . $moduleDirNameUpper . '_' . 'SHOW_SAMPLE_BUTTON_DESC',
+    'formtype'    => 'yesno',
+    'valuetype'   => 'int',
+    'default'     => 1,
 ];
 // Maintained by
 $modversion['config'][] = [
-	'name'        => 'maintainedby',
-	'title'       => '_MI_WGGITHUB_MAINTAINEDBY',
-	'description' => '_MI_WGGITHUB_MAINTAINEDBY_DESC',
-	'formtype'    => 'textbox',
-	'valuetype'   => 'text',
-	'default'     => 'https://xoops.org/modules/newbb',
+    'name'        => 'maintainedby',
+    'title'       => '_MI_WGGITHUB_MAINTAINEDBY',
+    'description' => '_MI_WGGITHUB_MAINTAINEDBY_DESC',
+    'formtype'    => 'textbox',
+    'valuetype'   => 'text',
+    'default'     => 'https://xoops.org/modules/newbb',
 ];

class/Github/Paginator.php

Indentation +142 added lines, -142 removed lines

@@ -12,147 +12,147 @@
  */
 class Paginator extends Sanity implements \Iterator
 {
-	/** @var Api */
-	private $api;
-
-	/** @var Http\Request */
-	private $firstRequest;
-
-	/** @var Http\Request|NULL */
-	private $request;
-
-	/** @var Http\Response|NULL */
-	private $response;
-
-	/** @var int */
-	private $limit;
-
-	/** @var int */
-	private $counter = 0;
-
-
-	public function __construct(Api $api, Http\Request $request)
-	{
-		$this->api = $api;
-		$this->firstRequest = clone $request;
-	}
-
-
-	/**
-	 * Limits maximum steps of iteration.
-	 *
-	 * @param  int|NULL
-	 * @return self
-	 */
-	public function limit($limit)
-	{
-		$this->limit = $limit === NULL
-			? NULL
-			: (int) $limit;
-
-		return $this;
-	}
-
-
-	/**
-	 * @return void
-	 */
-	public function rewind()
-	{
-		$this->request = $this->firstRequest;
-		$this->response = NULL;
-		$this->counter = 0;
-	}
-
-
-	/**
-	 * @return bool
-	 */
-	public function valid()
-	{
-		return $this->request !== NULL && ($this->limit === NULL || $this->counter < $this->limit);
-	}
-
-
-	/**
-	 * @return Http\Response
-	 */
-	public function current()
-	{
-		$this->load();
-		return $this->response;
-	}
-
-
-	/**
-	 * @return int
-	 */
-	public function key()
-	{
-		return static::parsePage($this->request->getUrl());
-	}
-
-
-	/**
-	 * @return void
-	 */
-	public function next()
-	{
-		$this->load();
-
-		if ($url = static::parseLink($this->response->getHeader('Link'), 'next')) {
-			$this->request = new Http\Request(
-				$this->request->getMethod(),
-				$url,
-				$this->request->getHeaders(),
-				$this->request->getContent()
-			);
-		} else {
-			$this->request = NULL;
-		}
-
-		$this->response = NULL;
-		$this->counter++;
-	}
-
-
-	private function load()
-	{
-		if ($this->response === NULL) {
-			$this->response = $this->api->request($this->request);
-		}
-	}
-
-
-	/**
-	 * @param  string
-	 * @return int
-	 */
-	public static function parsePage($url)
-	{
-		list (, $parametersStr) = explode('?', $url, 2) + ['', ''];
-		parse_str($parametersStr, $parameters);
-
-		return isset($parameters['page'])
-			? max(1, (int) $parameters['page'])
-			: 1;
-	}
-
-
-	/**
-	 * @see  https://developer.github.com/guides/traversing-with-pagination/#navigating-through-the-pages
-	 *
-	 * @param  string
-	 * @param  string
-	 * @return string|NULL
-	 */
-	public static function parseLink($link, $rel)
-	{
-		if (!preg_match('(<([^>]+)>;\s*rel="' . preg_quote($rel) . '")', $link, $match)) {
-			return NULL;
-		}
-
-		return $match[1];
-	}
+    /** @var Api */
+    private $api;
+
+    /** @var Http\Request */
+    private $firstRequest;
+
+    /** @var Http\Request|NULL */
+    private $request;
+
+    /** @var Http\Response|NULL */
+    private $response;
+
+    /** @var int */
+    private $limit;
+
+    /** @var int */
+    private $counter = 0;
+
+
+    public function __construct(Api $api, Http\Request $request)
+    {
+        $this->api = $api;
+        $this->firstRequest = clone $request;
+    }
+
+
+    /**
+     * Limits maximum steps of iteration.
+     *
+     * @param  int|NULL
+     * @return self
+     */
+    public function limit($limit)
+    {
+        $this->limit = $limit === NULL
+            ? NULL
+            : (int) $limit;
+
+        return $this;
+    }
+
+
+    /**
+     * @return void
+     */
+    public function rewind()
+    {
+        $this->request = $this->firstRequest;
+        $this->response = NULL;
+        $this->counter = 0;
+    }
+
+
+    /**
+     * @return bool
+     */
+    public function valid()
+    {
+        return $this->request !== NULL && ($this->limit === NULL || $this->counter < $this->limit);
+    }
+
+
+    /**
+     * @return Http\Response
+     */
+    public function current()
+    {
+        $this->load();
+        return $this->response;
+    }
+
+
+    /**
+     * @return int
+     */
+    public function key()
+    {
+        return static::parsePage($this->request->getUrl());
+    }
+
+
+    /**
+     * @return void
+     */
+    public function next()
+    {
+        $this->load();
+
+        if ($url = static::parseLink($this->response->getHeader('Link'), 'next')) {
+            $this->request = new Http\Request(
+                $this->request->getMethod(),
+                $url,
+                $this->request->getHeaders(),
+                $this->request->getContent()
+            );
+        } else {
+            $this->request = NULL;
+        }
+
+        $this->response = NULL;
+        $this->counter++;
+    }
+
+
+    private function load()
+    {
+        if ($this->response === NULL) {
+            $this->response = $this->api->request($this->request);
+        }
+    }
+
+
+    /**
+     * @param  string
+     * @return int
+     */
+    public static function parsePage($url)
+    {
+        list (, $parametersStr) = explode('?', $url, 2) + ['', ''];
+        parse_str($parametersStr, $parameters);
+
+        return isset($parameters['page'])
+            ? max(1, (int) $parameters['page'])
+            : 1;
+    }
+
+
+    /**
+     * @see  https://developer.github.com/guides/traversing-with-pagination/#navigating-through-the-pages
+     *
+     * @param  string
+     * @param  string
+     * @return string|NULL
+     */
+    public static function parseLink($link, $rel)
+    {
+        if (!preg_match('(<([^>]+)>;\s*rel="' . preg_quote($rel) . '")', $link, $match)) {
+            return NULL;
+        }
+
+        return $match[1];
+    }
 
 }

class/Github/Sanity.php

Indentation +14 added lines, -14 removed lines

@@ -8,21 +8,21 @@
  */
 abstract class Sanity
 {
-	/**
-	 * @throws LogicException
-	 */
-	public function & __get($name)
-	{
-		throw new LogicException('Cannot read an undeclared property ' . get_class($this) . "::\$$name.");
-	}
+    /**
+     * @throws LogicException
+     */
+    public function & __get($name)
+    {
+        throw new LogicException('Cannot read an undeclared property ' . get_class($this) . "::\$$name.");
+    }
 
 
-	/**
-	 * @throws LogicException
-	 */
-	public function __set($name, $value)
-	{
-		throw new LogicException('Cannot write to an undeclared property ' . get_class($this) . "::\$$name.");
-	}
+    /**
+     * @throws LogicException
+     */
+    public function __set($name, $value)
+    {
+        throw new LogicException('Cannot write to an undeclared property ' . get_class($this) . "::\$$name.");
+    }
 
 }

class/Github/Api.php

Indentation +590 added lines, -590 removed lines

@@ -12,595 +12,595 @@
  */
 class Api extends Sanity
 {
-	/** @var string */
-	private $url = 'https://api.github.com';
-
-	/** @var string */
-	private $defaultAccept = 'application/vnd.github.v3+json';
-
-	/** @var array|NULL */
-	private $defaultParameters = [];
-
-	/** @var Http\IClient */
-	private $client;
-
-	/** @var OAuth\Token|NULL */
-	private $token;
-
-
-	public function __construct(Http\IClient $client = NULL)
-	{
-		$this->client = $client ?: Helpers::createDefaultClient();
-	}
-
-
-	/**
-	 * @return self
-	 */
-	public function setToken(OAuth\Token $token = NULL)
-	{
-		$this->token = $token;
-		return $this;
-	}
-
-
-	/**
-	 * @return OAuth\Token|NULL
-	 */
-	public function getToken()
-	{
-		return $this->token;
-	}
-
-
-	/**
-	 * @param  array
-	 * @return self
-	 */
-	public function setDefaultParameters(array $defaults = NULL)
-	{
-		$this->defaultParameters = $defaults ?: [];
-		return $this;
-	}
-
-
-	/**
-	 * @return array
-	 */
-	public function getDefaultParameters()
-	{
-		return $this->defaultParameters;
-	}
-
-
-	/**
-	 * @param  string
-	 * @return self
-	 */
-	public function setDefaultAccept($accept)
-	{
-		$this->defaultAccept = $accept;
-		return $this;
-	}
-
-
-	/**
-	 * @return string
-	 */
-	public function getDefaultAccept()
-	{
-		return $this->defaultAccept;
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 */
-	public function delete($urlPath, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::DELETE, $urlPath, $parameters, $headers)
-		);
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 */
-	public function get($urlPath, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::GET, $urlPath, $parameters, $headers)
-		);
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 */
-	public function head($urlPath, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::HEAD, $urlPath, $parameters, $headers)
-		);
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @param  mixed
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 * @throws JsonException
-	 */
-	public function patch($urlPath, $content, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::PATCH, $urlPath, $parameters, $headers, $content)
-		);
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @param  mixed
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 * @throws JsonException
-	 */
-	public function post($urlPath, $content, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::POST, $urlPath, $parameters, $headers, $content)
-		);
-	}
-
-
-	/**
-	 * @see createRequest()
-	 * @see request()
-	 *
-	 * @param  string
-	 * @param  mixed
-	 * @return Http\Response
-	 *
-	 * @throws MissingParameterException
-	 * @throws JsonException
-	 */
-	public function put($urlPath, $content = NULL, array $parameters = [], array $headers = [])
-	{
-		return $this->request(
-			$this->createRequest(Http\Request::PUT, $urlPath, $parameters, $headers, $content)
-		);
-	}
-
-
-	/**
-	 * @return Http\Response
-	 *
-	 * @throws Http\BadResponseException
-	 */
-	public function request(Http\Request $request)
-	{
-		$request = clone $request;
-
-		$request->addHeader('Accept', $this->defaultAccept);
-		$request->addHeader('Time-Zone', date_default_timezone_get());
-		$request->addHeader('User-Agent', 'milo/github-api');
-
-		if ($this->token) {
-			/** @todo Distinguish token type? */
-			$request->addHeader('Authorization', "token {$this->token->getValue()}");
-		}
-
-		return $this->client->request($request);
-	}
-
-
-	/**
-	 * @param  string  Http\Request::GET|POST|...
-	 * @param  string  path like '/users/:user/repos' where ':user' is substitution
-	 * @param  array[name => value]  replaces substitutions in $urlPath, the rest is appended as query string to URL
-	 * @param  array[name => value]  name is case-insensitive
-	 * @param  mixed|NULL  arrays and objects are encoded to JSON and Content-Type is set
-	 * @return Http\Request
-	 *
-	 * @throws MissingParameterException  when substitution is used in URL but parameter is missing
-	 * @throws JsonException  when encoding to JSON fails
-	 */
-	public function createRequest($method, $urlPath, array $parameters = [], array $headers = [], $content = NULL)
-	{
-		if (stripos($urlPath, $this->url) === 0) {  # Allows non-HTTPS URLs
-			$baseUrl = $this->url;
-			$urlPath = substr($urlPath, strlen($this->url));
-
-		} elseif (preg_match('#^(https://[^/]+)(/.*)?$#', $urlPath, $m)) {
-			$baseUrl = $m[1];
-			$urlPath = isset($m[2]) ? $m[2] : '';
-
-		} else {
-			$baseUrl = $this->url;
-		}
-
-		if (strpos($urlPath, '{') === FALSE) {
-			$urlPath = $this->expandColonParameters($urlPath, $parameters, $this->defaultParameters);
-		} else {
-			$urlPath = $this->expandUriTemplate($urlPath, $parameters, $this->defaultParameters);
-		}
-
-		$url = rtrim($baseUrl, '/') . '/' . ltrim($urlPath, '/');
-
-		if ($content !== NULL && (is_array($content) || is_object($content))) {
-			$headers['Content-Type'] = 'application/json; charset=utf-8';
-			$content = Helpers::jsonEncode($content);
-		}
-
-		return new Http\Request($method, $url, $headers, $content);
-	}
-
-
-	/**
-	 * @param  Http\Response
-	 * @param  array|NULL  these codes are treated as success; code < 300 if NULL
-	 * @return mixed
-	 *
-	 * @throws ApiException
-	 */
-	public function decode(Http\Response $response, array $okCodes = NULL)
-	{
-		$content = $response->getContent();
-		if (preg_match('~application/json~i', $response->getHeader('Content-Type', ''))) {
-			try {
-				$content = Helpers::jsonDecode($response->getContent(), true);
-			} catch (JsonException $e) {
-				throw new InvalidResponseException('JSON decoding failed.', 0, $e, $response);
-			}
-
-			if (!is_array($content) && !is_object($content)) {
-				throw new InvalidResponseException('Decoded JSON is not an array or object.', 0, NULL, $response);
-			}
-		}
-
-		$code = $response->getCode();
-		if (($okCodes === NULL && $code >= 300) || (is_array($okCodes) && !in_array($code, $okCodes))) {
-			/** @var $content \stdClass */
-			switch ($code) {
-				case Http\Response::S400_BAD_REQUEST:
-					throw new BadRequestException(self::errorMessage($content), $code, NULL, $response);
-
-				case Http\Response::S401_UNAUTHORIZED:
-					throw new UnauthorizedException(self::errorMessage($content), $code, NULL, $response);
-
-				case Http\Response::S403_FORBIDDEN:
-					if ($response->getHeader('X-RateLimit-Remaining') === '0') {
-						throw new RateLimitExceedException(self::errorMessage($content), $code, NULL, $response);
-					}
-					throw new ForbiddenException(self::errorMessage($content), $code, NULL, $response);
-
-				case Http\Response::S404_NOT_FOUND:
-					throw new NotFoundException('Resource not found or not authorized to access.', $code, NULL, $response);
-
-				case Http\Response::S422_UNPROCESSABLE_ENTITY:
-					throw new UnprocessableEntityException(self::errorMessage($content), $code, NULL, $response);
-			}
-
-			$message = $okCodes === NULL ? '< 300' : implode(' or ', $okCodes);
-			throw new UnexpectedResponseException("Expected response with code $message.", $code, NULL, $response);
-		}
-
-		return $content;
-	}
-
-
-	/**
-	 * Creates paginator for HTTP GET requests.
-	 *
-	 * @see get()
-	 *
-	 * @param  string
-	 * @return Paginator
-	 *
-	 * @throws MissingParameterException
-	 */
-	public function paginator($urlPath, array $parameters = [], array $headers = [])
-	{
-		return new Paginator(
-			$this,
-			$this->createRequest(Http\Request::GET, $urlPath, $parameters, $headers)
-		);
-	}
-
-
-	/**
-	 * @return Http\IClient
-	 */
-	public function getClient()
-	{
-		return $this->client;
-	}
-
-
-	/**
-	 * @param  string
-	 * @return Api
-	 */
-	public function withUrl($url)
-	{
-		$api = clone $this;
-		$api->setUrl($url);
-		return $api;
-	}
-
-
-	/**
-	 * @param  string
-	 * @return self
-	 */
-	public function setUrl($url)
-	{
-		$this->url = $url;
-		return $this;
-	}
-
-
-	/**
-	 * @return string
-	 */
-	public function getUrl()
-	{
-		return $this->url;
-	}
-
-
-	/**
-	 * @param  string
-	 * @return string
-	 *
-	 * @throws MissingParameterException
-	 */
-	protected function expandColonParameters($url, array $parameters, array $defaultParameters)
-	{
-		$parameters += $defaultParameters;
-
-		$url = preg_replace_callback('#(^|/|\.):([^/.]+)#', function($m) use ($url, & $parameters) {
-			if (!isset($parameters[$m[2]])) {
-				throw new MissingParameterException("Missing parameter '$m[2]' for URL path '$url'.");
-			}
-			$parameter = $parameters[$m[2]];
-			unset($parameters[$m[2]]);
-			return $m[1] . rawurlencode($parameter);
-		}, $url);
-
-		$url = rtrim($url, '/');
-
-		if (count($parameters)) {
-			$url .= '?' . http_build_query($parameters);
-		}
-
-		return $url;
-	}
-
-
-	/**
-	 * Expands URI template (RFC 6570).
-	 *
-	 * @see http://tools.ietf.org/html/rfc6570
-	 * @todo Inject remaining default parameters into query string?
-	 *
-	 * @param  string
-	 * @return string
-	 */
-	protected function expandUriTemplate($url, array $parameters, array $defaultParameters)
-	{
-		$parameters += $defaultParameters;
-
-		static $operatorFlags = [
-			''  => ['prefix' => '',  'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
-			'+' => ['prefix' => '',  'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => TRUE],
-			'#' => ['prefix' => '#', 'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => TRUE],
-			'.' => ['prefix' => '.', 'separator' => '.', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
-			'/' => ['prefix' => '/', 'separator' => '/', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
-			';' => ['prefix' => ';', 'separator' => ';', 'named' => TRUE,  'ifEmpty' => '',  'reserved' => FALSE],
-			'?' => ['prefix' => '?', 'separator' => '&', 'named' => TRUE,  'ifEmpty' => '=', 'reserved' => FALSE],
-			'&' => ['prefix' => '&', 'separator' => '&', 'named' => TRUE,  'ifEmpty' => '=', 'reserved' => FALSE],
-		];
-
-		return preg_replace_callback('~{([+#./;?&])?([^}]+?)}~', function($m) use ($url, & $parameters, $operatorFlags) {
-			$flags = $operatorFlags[$m[1]];
-
-			$translated = [];
-			foreach (explode(',', $m[2]) as $name) {
-				$explode = FALSE;
-				$maxLength = NULL;
-				if (preg_match('~^(.+)(?:(\*)|:(\d+))$~', $name, $tmp)) { // TODO: Speed up?
-					$name = $tmp[1];
-					if (isset($tmp[3])) {
-						$maxLength = (int) $tmp[3];
-					} else {
-						$explode = TRUE;
-					}
-				}
-
-				if (!isset($parameters[$name])) {  // TODO: Throw exception?
-					continue;
-				}
-
-				$value = $parameters[$name];
-				if (is_scalar($value)) {
-					$translated[] = $this->prefix($flags, $name, $this->escape($flags, $value, $maxLength));
-
-				} else {
-					$value = (array) $value;
-					$isAssoc = key($value) !== 0;
-
-					// The '*' (explode) modifier
-					if ($explode) {
-						$parts = [];
-						if ($isAssoc) {
-							$this->walk($value, function ($v, $k) use (& $parts, $flags, $maxLength) {
-								$parts[] = $this->prefix(['named' => TRUE] + $flags, $k, $this->escape($flags, $v, $maxLength));
-							});
-
-						} elseif ($flags['named']) {
-							$this->walk($value, function ($v) use (& $parts, $flags, $name, $maxLength) {
-								$parts[] = $this->prefix($flags, $name, $this->escape($flags, $v, $maxLength));
-							});
-
-						} else {
-							$this->walk($value, function ($v) use (& $parts, $flags, $maxLength) {
-								$parts[] = $this->escape($flags, $v, $maxLength);
-							});
-						}
-
-						if (isset($parts[0])) {
-							if ($flags['named']) {
-								$translated[] = implode($flags['separator'], $parts);
-							} else {
-								$translated[] = $this->prefix($flags, $name, implode($flags['separator'], $parts));
-							}
-						}
-
-					} else {
-						$parts = [];
-						$this->walk($value, function($v, $k) use (& $parts, $isAssoc, $flags, $maxLength) {
-							if ($isAssoc) {
-								$parts[] = $this->escape($flags, $k);
-							}
-
-							$parts[] = $this->escape($flags, $v, $maxLength);
-						});
-
-						if (isset($parts[0])) {
-							$translated[] = $this->prefix($flags, $name, implode(',', $parts));
-						}
-					}
-				}
-			}
-
-			if (isset($translated[0])) {
-				return $flags['prefix'] . implode($flags['separator'], $translated);
-			}
-
-			return '';
-		}, $url);
-	}
-
-
-	/**
-	 * @param  array
-	 * @param  string
-	 * @param  string  already escaped
-	 * @return string
-	 */
-	private function prefix(array $flags, $name, $value)
-	{
-		$prefix = '';
-		if ($flags['named']) {
-			$prefix .= $this->escape($flags, $name);
-			if (isset($value[0])) {
-				$prefix .= '=';
-			} else {
-				$prefix .= $flags['ifEmpty'];
-			}
-		}
-
-		return $prefix . $value;
-	}
-
-
-	/**
-	 * @param  array
-	 * @param  mixed
-	 * @param  int|NULL
-	 * @return string
-	 */
-	private function escape(array $flags, $value, $maxLength = NULL)
-	{
-		$value = (string) $value;
-
-		if ($maxLength !== NULL) {
-			if (preg_match('~^(.{' . $maxLength . '}).~u', $value, $m)) {
-				$value = $m[1];
-			} elseif (strlen($value) > $maxLength) {  # when malformed UTF-8
-				$value = substr($value, 0, $maxLength);
-			}
-		}
-
-		if ($flags['reserved']) {
-			$parts = preg_split('~(%[0-9a-fA-F]{2}|[:/?#[\]@!$&\'()*+,;=])~', $value, -1, PREG_SPLIT_DELIM_CAPTURE);
-			$parts[] = '';
-
-			$escaped = '';
-			for ($i = 0, $count = count($parts); $i < $count; $i += 2) {
-				$escaped .= rawurlencode($parts[$i]) . $parts[$i + 1];
-			}
-
-			return $escaped;
-		}
-
-		return rawurlencode($value);
-	}
-
-
-	/**
-	 * @param  array
-	 * @param  callable
-	 */
-	private function walk(array $array, $cb)
-	{
-		foreach ($array as $k => $v) {
-			if ($v === NULL) {
-				continue;
-			}
-
-			$cb($v, $k);
-		}
-	}
-
-
-	/**
-	 * @param  \stdClass
-	 * @return string
-	 */
-	private static function errorMessage($content)
-	{
-		$message = isset($content->message)
-			? $content->message
-			: 'Unknown error';
-
-		if (isset($content->errors)) {
-			$message .= implode(', ', array_map(function($error) {
-				return '[' . implode(':', (array) $error) . ']';
-			}, $content->errors));
-		}
-
-		return $message;
-	}
+    /** @var string */
+    private $url = 'https://api.github.com';
+
+    /** @var string */
+    private $defaultAccept = 'application/vnd.github.v3+json';
+
+    /** @var array|NULL */
+    private $defaultParameters = [];
+
+    /** @var Http\IClient */
+    private $client;
+
+    /** @var OAuth\Token|NULL */
+    private $token;
+
+
+    public function __construct(Http\IClient $client = NULL)
+    {
+        $this->client = $client ?: Helpers::createDefaultClient();
+    }
+
+
+    /**
+     * @return self
+     */
+    public function setToken(OAuth\Token $token = NULL)
+    {
+        $this->token = $token;
+        return $this;
+    }
+
+
+    /**
+     * @return OAuth\Token|NULL
+     */
+    public function getToken()
+    {
+        return $this->token;
+    }
+
+
+    /**
+     * @param  array
+     * @return self
+     */
+    public function setDefaultParameters(array $defaults = NULL)
+    {
+        $this->defaultParameters = $defaults ?: [];
+        return $this;
+    }
+
+
+    /**
+     * @return array
+     */
+    public function getDefaultParameters()
+    {
+        return $this->defaultParameters;
+    }
+
+
+    /**
+     * @param  string
+     * @return self
+     */
+    public function setDefaultAccept($accept)
+    {
+        $this->defaultAccept = $accept;
+        return $this;
+    }
+
+
+    /**
+     * @return string
+     */
+    public function getDefaultAccept()
+    {
+        return $this->defaultAccept;
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     */
+    public function delete($urlPath, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::DELETE, $urlPath, $parameters, $headers)
+        );
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     */
+    public function get($urlPath, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::GET, $urlPath, $parameters, $headers)
+        );
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     */
+    public function head($urlPath, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::HEAD, $urlPath, $parameters, $headers)
+        );
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @param  mixed
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     * @throws JsonException
+     */
+    public function patch($urlPath, $content, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::PATCH, $urlPath, $parameters, $headers, $content)
+        );
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @param  mixed
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     * @throws JsonException
+     */
+    public function post($urlPath, $content, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::POST, $urlPath, $parameters, $headers, $content)
+        );
+    }
+
+
+    /**
+     * @see createRequest()
+     * @see request()
+     *
+     * @param  string
+     * @param  mixed
+     * @return Http\Response
+     *
+     * @throws MissingParameterException
+     * @throws JsonException
+     */
+    public function put($urlPath, $content = NULL, array $parameters = [], array $headers = [])
+    {
+        return $this->request(
+            $this->createRequest(Http\Request::PUT, $urlPath, $parameters, $headers, $content)
+        );
+    }
+
+
+    /**
+     * @return Http\Response
+     *
+     * @throws Http\BadResponseException
+     */
+    public function request(Http\Request $request)
+    {
+        $request = clone $request;
+
+        $request->addHeader('Accept', $this->defaultAccept);
+        $request->addHeader('Time-Zone', date_default_timezone_get());
+        $request->addHeader('User-Agent', 'milo/github-api');
+
+        if ($this->token) {
+            /** @todo Distinguish token type? */
+            $request->addHeader('Authorization', "token {$this->token->getValue()}");
+        }
+
+        return $this->client->request($request);
+    }
+
+
+    /**
+     * @param  string  Http\Request::GET|POST|...
+     * @param  string  path like '/users/:user/repos' where ':user' is substitution
+     * @param  array[name => value]  replaces substitutions in $urlPath, the rest is appended as query string to URL
+     * @param  array[name => value]  name is case-insensitive
+     * @param  mixed|NULL  arrays and objects are encoded to JSON and Content-Type is set
+     * @return Http\Request
+     *
+     * @throws MissingParameterException  when substitution is used in URL but parameter is missing
+     * @throws JsonException  when encoding to JSON fails
+     */
+    public function createRequest($method, $urlPath, array $parameters = [], array $headers = [], $content = NULL)
+    {
+        if (stripos($urlPath, $this->url) === 0) {  # Allows non-HTTPS URLs
+            $baseUrl = $this->url;
+            $urlPath = substr($urlPath, strlen($this->url));
+
+        } elseif (preg_match('#^(https://[^/]+)(/.*)?$#', $urlPath, $m)) {
+            $baseUrl = $m[1];
+            $urlPath = isset($m[2]) ? $m[2] : '';
+
+        } else {
+            $baseUrl = $this->url;
+        }
+
+        if (strpos($urlPath, '{') === FALSE) {
+            $urlPath = $this->expandColonParameters($urlPath, $parameters, $this->defaultParameters);
+        } else {
+            $urlPath = $this->expandUriTemplate($urlPath, $parameters, $this->defaultParameters);
+        }
+
+        $url = rtrim($baseUrl, '/') . '/' . ltrim($urlPath, '/');
+
+        if ($content !== NULL && (is_array($content) || is_object($content))) {
+            $headers['Content-Type'] = 'application/json; charset=utf-8';
+            $content = Helpers::jsonEncode($content);
+        }
+
+        return new Http\Request($method, $url, $headers, $content);
+    }
+
+
+    /**
+     * @param  Http\Response
+     * @param  array|NULL  these codes are treated as success; code < 300 if NULL
+     * @return mixed
+     *
+     * @throws ApiException
+     */
+    public function decode(Http\Response $response, array $okCodes = NULL)
+    {
+        $content = $response->getContent();
+        if (preg_match('~application/json~i', $response->getHeader('Content-Type', ''))) {
+            try {
+                $content = Helpers::jsonDecode($response->getContent(), true);
+            } catch (JsonException $e) {
+                throw new InvalidResponseException('JSON decoding failed.', 0, $e, $response);
+            }
+
+            if (!is_array($content) && !is_object($content)) {
+                throw new InvalidResponseException('Decoded JSON is not an array or object.', 0, NULL, $response);
+            }
+        }
+
+        $code = $response->getCode();
+        if (($okCodes === NULL && $code >= 300) || (is_array($okCodes) && !in_array($code, $okCodes))) {
+            /** @var $content \stdClass */
+            switch ($code) {
+                case Http\Response::S400_BAD_REQUEST:
+                    throw new BadRequestException(self::errorMessage($content), $code, NULL, $response);
+
+                case Http\Response::S401_UNAUTHORIZED:
+                    throw new UnauthorizedException(self::errorMessage($content), $code, NULL, $response);
+
+                case Http\Response::S403_FORBIDDEN:
+                    if ($response->getHeader('X-RateLimit-Remaining') === '0') {
+                        throw new RateLimitExceedException(self::errorMessage($content), $code, NULL, $response);
+                    }
+                    throw new ForbiddenException(self::errorMessage($content), $code, NULL, $response);
+
+                case Http\Response::S404_NOT_FOUND:
+                    throw new NotFoundException('Resource not found or not authorized to access.', $code, NULL, $response);
+
+                case Http\Response::S422_UNPROCESSABLE_ENTITY:
+                    throw new UnprocessableEntityException(self::errorMessage($content), $code, NULL, $response);
+            }
+
+            $message = $okCodes === NULL ? '< 300' : implode(' or ', $okCodes);
+            throw new UnexpectedResponseException("Expected response with code $message.", $code, NULL, $response);
+        }
+
+        return $content;
+    }
+
+
+    /**
+     * Creates paginator for HTTP GET requests.
+     *
+     * @see get()
+     *
+     * @param  string
+     * @return Paginator
+     *
+     * @throws MissingParameterException
+     */
+    public function paginator($urlPath, array $parameters = [], array $headers = [])
+    {
+        return new Paginator(
+            $this,
+            $this->createRequest(Http\Request::GET, $urlPath, $parameters, $headers)
+        );
+    }
+
+
+    /**
+     * @return Http\IClient
+     */
+    public function getClient()
+    {
+        return $this->client;
+    }
+
+
+    /**
+     * @param  string
+     * @return Api
+     */
+    public function withUrl($url)
+    {
+        $api = clone $this;
+        $api->setUrl($url);
+        return $api;
+    }
+
+
+    /**
+     * @param  string
+     * @return self
+     */
+    public function setUrl($url)
+    {
+        $this->url = $url;
+        return $this;
+    }
+
+
+    /**
+     * @return string
+     */
+    public function getUrl()
+    {
+        return $this->url;
+    }
+
+
+    /**
+     * @param  string
+     * @return string
+     *
+     * @throws MissingParameterException
+     */
+    protected function expandColonParameters($url, array $parameters, array $defaultParameters)
+    {
+        $parameters += $defaultParameters;
+
+        $url = preg_replace_callback('#(^|/|\.):([^/.]+)#', function($m) use ($url, & $parameters) {
+            if (!isset($parameters[$m[2]])) {
+                throw new MissingParameterException("Missing parameter '$m[2]' for URL path '$url'.");
+            }
+            $parameter = $parameters[$m[2]];
+            unset($parameters[$m[2]]);
+            return $m[1] . rawurlencode($parameter);
+        }, $url);
+
+        $url = rtrim($url, '/');
+
+        if (count($parameters)) {
+            $url .= '?' . http_build_query($parameters);
+        }
+
+        return $url;
+    }
+
+
+    /**
+     * Expands URI template (RFC 6570).
+     *
+     * @see http://tools.ietf.org/html/rfc6570
+     * @todo Inject remaining default parameters into query string?
+     *
+     * @param  string
+     * @return string
+     */
+    protected function expandUriTemplate($url, array $parameters, array $defaultParameters)
+    {
+        $parameters += $defaultParameters;
+
+        static $operatorFlags = [
+            ''  => ['prefix' => '',  'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
+            '+' => ['prefix' => '',  'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => TRUE],
+            '#' => ['prefix' => '#', 'separator' => ',', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => TRUE],
+            '.' => ['prefix' => '.', 'separator' => '.', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
+            '/' => ['prefix' => '/', 'separator' => '/', 'named' => FALSE, 'ifEmpty' => '',  'reserved' => FALSE],
+            ';' => ['prefix' => ';', 'separator' => ';', 'named' => TRUE,  'ifEmpty' => '',  'reserved' => FALSE],
+            '?' => ['prefix' => '?', 'separator' => '&', 'named' => TRUE,  'ifEmpty' => '=', 'reserved' => FALSE],
+            '&' => ['prefix' => '&', 'separator' => '&', 'named' => TRUE,  'ifEmpty' => '=', 'reserved' => FALSE],
+        ];
+
+        return preg_replace_callback('~{([+#./;?&])?([^}]+?)}~', function($m) use ($url, & $parameters, $operatorFlags) {
+            $flags = $operatorFlags[$m[1]];
+
+            $translated = [];
+            foreach (explode(',', $m[2]) as $name) {
+                $explode = FALSE;
+                $maxLength = NULL;
+                if (preg_match('~^(.+)(?:(\*)|:(\d+))$~', $name, $tmp)) { // TODO: Speed up?
+                    $name = $tmp[1];
+                    if (isset($tmp[3])) {
+                        $maxLength = (int) $tmp[3];
+                    } else {
+                        $explode = TRUE;
+                    }
+                }
+
+                if (!isset($parameters[$name])) {  // TODO: Throw exception?
+                    continue;
+                }
+
+                $value = $parameters[$name];
+                if (is_scalar($value)) {
+                    $translated[] = $this->prefix($flags, $name, $this->escape($flags, $value, $maxLength));
+
+                } else {
+                    $value = (array) $value;
+                    $isAssoc = key($value) !== 0;
+
+                    // The '*' (explode) modifier
+                    if ($explode) {
+                        $parts = [];
+                        if ($isAssoc) {
+                            $this->walk($value, function ($v, $k) use (& $parts, $flags, $maxLength) {
+                                $parts[] = $this->prefix(['named' => TRUE] + $flags, $k, $this->escape($flags, $v, $maxLength));
+                            });
+
+                        } elseif ($flags['named']) {
+                            $this->walk($value, function ($v) use (& $parts, $flags, $name, $maxLength) {
+                                $parts[] = $this->prefix($flags, $name, $this->escape($flags, $v, $maxLength));
+                            });
+
+                        } else {
+                            $this->walk($value, function ($v) use (& $parts, $flags, $maxLength) {
+                                $parts[] = $this->escape($flags, $v, $maxLength);
+                            });
+                        }
+
+                        if (isset($parts[0])) {
+                            if ($flags['named']) {
+                                $translated[] = implode($flags['separator'], $parts);
+                            } else {
+                                $translated[] = $this->prefix($flags, $name, implode($flags['separator'], $parts));
+                            }
+                        }
+
+                    } else {
+                        $parts = [];
+                        $this->walk($value, function($v, $k) use (& $parts, $isAssoc, $flags, $maxLength) {
+                            if ($isAssoc) {
+                                $parts[] = $this->escape($flags, $k);
+                            }
+
+                            $parts[] = $this->escape($flags, $v, $maxLength);
+                        });
+
+                        if (isset($parts[0])) {
+                            $translated[] = $this->prefix($flags, $name, implode(',', $parts));
+                        }
+                    }
+                }
+            }
+
+            if (isset($translated[0])) {
+                return $flags['prefix'] . implode($flags['separator'], $translated);
+            }
+
+            return '';
+        }, $url);
+    }
+
+
+    /**
+     * @param  array
+     * @param  string
+     * @param  string  already escaped
+     * @return string
+     */
+    private function prefix(array $flags, $name, $value)
+    {
+        $prefix = '';
+        if ($flags['named']) {
+            $prefix .= $this->escape($flags, $name);
+            if (isset($value[0])) {
+                $prefix .= '=';
+            } else {
+                $prefix .= $flags['ifEmpty'];
+            }
+        }
+
+        return $prefix . $value;
+    }
+
+
+    /**
+     * @param  array
+     * @param  mixed
+     * @param  int|NULL
+     * @return string
+     */
+    private function escape(array $flags, $value, $maxLength = NULL)
+    {
+        $value = (string) $value;
+
+        if ($maxLength !== NULL) {
+            if (preg_match('~^(.{' . $maxLength . '}).~u', $value, $m)) {
+                $value = $m[1];
+            } elseif (strlen($value) > $maxLength) {  # when malformed UTF-8
+                $value = substr($value, 0, $maxLength);
+            }
+        }
+
+        if ($flags['reserved']) {
+            $parts = preg_split('~(%[0-9a-fA-F]{2}|[:/?#[\]@!$&\'()*+,;=])~', $value, -1, PREG_SPLIT_DELIM_CAPTURE);
+            $parts[] = '';
+
+            $escaped = '';
+            for ($i = 0, $count = count($parts); $i < $count; $i += 2) {
+                $escaped .= rawurlencode($parts[$i]) . $parts[$i + 1];
+            }
+
+            return $escaped;
+        }
+
+        return rawurlencode($value);
+    }
+
+
+    /**
+     * @param  array
+     * @param  callable
+     */
+    private function walk(array $array, $cb)
+    {
+        foreach ($array as $k => $v) {
+            if ($v === NULL) {
+                continue;
+            }
+
+            $cb($v, $k);
+        }
+    }
+
+
+    /**
+     * @param  \stdClass
+     * @return string
+     */
+    private static function errorMessage($content)
+    {
+        $message = isset($content->message)
+            ? $content->message
+            : 'Unknown error';
+
+        if (isset($content->errors)) {
+            $message .= implode(', ', array_map(function($error) {
+                return '[' . implode(':', (array) $error) . ']';
+            }, $content->errors));
+        }
+
+        return $message;
+    }
 
 }

class/Github/exceptions.php

Indentation +114 added lines, -114 removed lines

@@ -8,169 +8,169 @@
  */
 
 namespace XoopsModules\Wggithub\Github\ {
-	/**
-	 * Marker interface.
-	 */
-	interface IException
-	{}
+    /**
+     * Marker interface.
+     */
+    interface IException
+    {}
 
 
-	/**
-	 * Wrong algorithm. API is used in wrong way. Application code should be changed.
-	 */
-	class LogicException extends \LogicException implements IException
-	{}
+    /**
+     * Wrong algorithm. API is used in wrong way. Application code should be changed.
+     */
+    class LogicException extends \LogicException implements IException
+    {}
 
 
-	/**
-	 * Substitution is used in URL path but corresponding parameter is missing.
-	 */
-	class MissingParameterException extends LogicException
-	{}
+    /**
+     * Substitution is used in URL path but corresponding parameter is missing.
+     */
+    class MissingParameterException extends LogicException
+    {}
 
 
-	/**
-	 * Unpredictable situation occurred.
-	 */
-	abstract class RuntimeException extends \RuntimeException implements IException
-	{}
+    /**
+     * Unpredictable situation occurred.
+     */
+    abstract class RuntimeException extends \RuntimeException implements IException
+    {}
 
 
-	/**
-	 * Github API returned a non-success HTTP code or data are somehow wrong. See all following descendants.
-	 *
-	 * @see Api::decode()
-	 * @see https://developer.github.com/v3/#client-errors
-	 */
-	abstract class ApiException extends RuntimeException
-	{
-		/** @var Http\Response|NULL */
-		private $response;
+    /**
+     * Github API returned a non-success HTTP code or data are somehow wrong. See all following descendants.
+     *
+     * @see Api::decode()
+     * @see https://developer.github.com/v3/#client-errors
+     */
+    abstract class ApiException extends RuntimeException
+    {
+        /** @var Http\Response|NULL */
+        private $response;
 
 
-		/**
-		 * @param string
-		 * @param int
-		 */
-		public function __construct($message = '', $code = 0, \Exception $previous = NULL, Http\Response $response = NULL)
-		{
-			parent::__construct($message, $code, $previous);
-			$this->response = clone $response;
-		}
+        /**
+         * @param string
+         * @param int
+         */
+        public function __construct($message = '', $code = 0, \Exception $previous = NULL, Http\Response $response = NULL)
+        {
+            parent::__construct($message, $code, $previous);
+            $this->response = clone $response;
+        }
 
 
-		/**
-		 * @return Http\Response|NULL
-		 */
-		final public function getResponse()
-		{
-			return $this->response;
-		}
+        /**
+         * @return Http\Response|NULL
+         */
+        final public function getResponse()
+        {
+            return $this->response;
+        }
 
-	}
+    }
 
 
-	/**
-	 * Invalid credentials (e.g. revoked token).
-	 */
-	class UnauthorizedException extends ApiException
-	{}
+    /**
+     * Invalid credentials (e.g. revoked token).
+     */
+    class UnauthorizedException extends ApiException
+    {}
 
 
-	/**
-	 * Invalid JSON sent to Github API.
-	 */
-	class BadRequestException extends ApiException
-	{}
+    /**
+     * Invalid JSON sent to Github API.
+     */
+    class BadRequestException extends ApiException
+    {}
 
 
-	/**
-	 * Invalid structure sent to Github API (e.g. some required fields are missing).
-	 */
-	class UnprocessableEntityException extends ApiException
-	{}
+    /**
+     * Invalid structure sent to Github API (e.g. some required fields are missing).
+     */
+    class UnprocessableEntityException extends ApiException
+    {}
 
 
-	/**
-	 * Access denied.
-	 * @see https://developer.github.com/v3/#authentication
-	 */
-	class ForbiddenException extends ApiException
-	{}
+    /**
+     * Access denied.
+     * @see https://developer.github.com/v3/#authentication
+     */
+    class ForbiddenException extends ApiException
+    {}
 
 
-	/**
-	 * Rate limit exceed.
-	 * @see https://developer.github.com/v3/#rate-limiting
-	 */
-	class RateLimitExceedException extends ForbiddenException
-	{}
+    /**
+     * Rate limit exceed.
+     * @see https://developer.github.com/v3/#rate-limiting
+     */
+    class RateLimitExceedException extends ForbiddenException
+    {}
 
 
-	/**
-	 * Resource not found.
-	 * @see https://developer.github.com/v3/#authentication
-	 */
-	class NotFoundException extends ApiException
-	{}
+    /**
+     * Resource not found.
+     * @see https://developer.github.com/v3/#authentication
+     */
+    class NotFoundException extends ApiException
+    {}
 
 
-	/**
-	 * Response cannot be classified.
-	 */
-	class UnexpectedResponseException extends ApiException
-	{}
+    /**
+     * Response cannot be classified.
+     */
+    class UnexpectedResponseException extends ApiException
+    {}
 
 
-	/**
-	 * Response from Github is somehow wrong (e.g. invalid JSON decoding).
-	 */
-	class InvalidResponseException extends ApiException
-	{}
+    /**
+     * Response from Github is somehow wrong (e.g. invalid JSON decoding).
+     */
+    class InvalidResponseException extends ApiException
+    {}
 
 
-	/**
-	 * JSON cannot be decoded, or value cannot be encoded to JSON.
-	 */
-	class JsonException extends RuntimeException
-	{
-	}
+    /**
+     * JSON cannot be decoded, or value cannot be encoded to JSON.
+     */
+    class JsonException extends RuntimeException
+    {
+    }
 
 }
 
 
 namespace XoopsModules\Wggithub\Github\Http {
-	use XoopsModules\Wggithub\Github;
+    use XoopsModules\Wggithub\Github;
 
 
-	/**
-	 * HTTP response is somehow wrong and cannot be processed.
-	 */
-	class BadResponseException extends Github\RuntimeException
-	{}
+    /**
+     * HTTP response is somehow wrong and cannot be processed.
+     */
+    class BadResponseException extends Github\RuntimeException
+    {}
 
 }
 
 
 namespace XoopsModules\Wggithub\Github\OAuth {
-	use XoopsModules\Wggithub\Github;
+    use XoopsModules\Wggithub\Github;
 
-	/**
-	 * Something fails during the token obtaining.
-	 */
-	class LoginException extends Github\RuntimeException
-	{}
+    /**
+     * Something fails during the token obtaining.
+     */
+    class LoginException extends Github\RuntimeException
+    {}
 
 }
 
 
 namespace XoopsModules\Wggithub\Github\Storages {
-	use XoopsModules\Wggithub\Github;
+    use XoopsModules\Wggithub\Github;
 
-	/**
-	 * Directory is missing and/or cannot be created.
-	 */
-	class MissingDirectoryException extends Github\RuntimeException
-	{}
+    /**
+     * Directory is missing and/or cannot be created.
+     */
+    class MissingDirectoryException extends Github\RuntimeException
+    {}
 
 }

class/Github/Http/CachedClient.php

Indentation +126 added lines, -126 removed lines

@@ -13,131 +13,131 @@
  */
 class CachedClient extends Github\Sanity implements IClient
 {
-	/** @var Storages\ICache|NULL */
-	private $cache;
-
-	/** @var IClient */
-	private $client;
-
-	/** @var bool */
-	private $forbidRecheck;
-
-	/** @var callable|NULL */
-	private $onResponse;
-
-
-	/**
-	 * @param Storages\ICache
-	 * @param IClient
-	 * @param bool  forbid checking Github for new data; more or less development purpose only
-	 */
-	public function __construct(Storages\ICache $cache, IClient $client = NULL, $forbidRecheck = FALSE)
-	{
-		$this->cache = $cache;
-		$this->client = $client ?: Github\Helpers::createDefaultClient();
-		$this->forbidRecheck = (bool) $forbidRecheck;
-	}
-
-
-	/**
-	 * @return IClient
-	 */
-	public function getInnerClient()
-	{
-		return $this->client;
-	}
-
-
-	/**
-	 * @return Response
-	 *
-	 * @throws BadResponseException
-	 */
-	public function request(Request $request)
-	{
-		$request = clone $request;
-
-		$cacheKey = implode('.', [
-			$request->getMethod(),
-			$request->getUrl(),
-
-			/** @todo This should depend on Vary: header */
-			$request->getHeader('Accept'),
-			$request->getHeader('Accept-Encoding'),
-			$request->getHeader('Authorization')
-		]);
-
-		if ($cached = $this->cache->load($cacheKey)) {
-			if ($this->forbidRecheck) {
-				$cached = clone $cached;
-				$this->onResponse && call_user_func($this->onResponse, $cached);
-				return $cached;
-			}
-
-			/** @var $cached Response */
-			if ($cached->hasHeader('Last-Modified')) {
-				$request->addHeader('If-Modified-Since', $cached->getHeader('Last-Modified'));
-			}
-			if ($cached->hasHeader('ETag')) {
-				$request->addHeader('If-None-Match', $cached->getHeader('ETag'));
-			}
-		}
-
-		$response = $this->client->request($request);
-
-		if ($this->isCacheable($response)) {
-			$this->cache->save($cacheKey, clone $response);
-		}
-
-		if (isset($cached) && $response->getCode() === Response::S304_NOT_MODIFIED) {
-			$cached = clone $cached;
-
-			/** @todo Should be responses somehow combined into one? */
-			$response = $cached->setPrevious($response);
-		}
-
-		$this->onResponse && call_user_func($this->onResponse, $response);
-
-		return $response;
-	}
-
-
-	/**
-	 * @param  callable|NULL function(Request $request)
-	 * @return self
-	 */
-	public function onRequest($callback)
-	{
-		$this->client->onRequest($callback);
-		return $this;
-	}
-
-
-	/**
-	 * @param  callable|NULL function(Response $response)
-	 * @return self
-	 */
-	public function onResponse($callback)
-	{
-		$this->client->onResponse(NULL);
-		$this->onResponse = $callback;
-		return $this;
-	}
-
-
-	/**
-	 * @return bool
-	 */
-	protected function isCacheable(Response $response)
-	{
-		/** @todo Do it properly. Vary:, Pragma:, TTL...  */
-		if (!$response->isCode(200)) {
-			return FALSE;
-		} elseif (preg_match('#max-age=0|must-revalidate#i', $response->getHeader('Cache-Control', ''))) {
-			return FALSE;
-		}
-
-		return $response->hasHeader('ETag') || $response->hasHeader('Last-Modified');
-	}
+    /** @var Storages\ICache|NULL */
+    private $cache;
+
+    /** @var IClient */
+    private $client;
+
+    /** @var bool */
+    private $forbidRecheck;
+
+    /** @var callable|NULL */
+    private $onResponse;
+
+
+    /**
+     * @param Storages\ICache
+     * @param IClient
+     * @param bool  forbid checking Github for new data; more or less development purpose only
+     */
+    public function __construct(Storages\ICache $cache, IClient $client = NULL, $forbidRecheck = FALSE)
+    {
+        $this->cache = $cache;
+        $this->client = $client ?: Github\Helpers::createDefaultClient();
+        $this->forbidRecheck = (bool) $forbidRecheck;
+    }
+
+
+    /**
+     * @return IClient
+     */
+    public function getInnerClient()
+    {
+        return $this->client;
+    }
+
+
+    /**
+     * @return Response
+     *
+     * @throws BadResponseException
+     */
+    public function request(Request $request)
+    {
+        $request = clone $request;
+
+        $cacheKey = implode('.', [
+            $request->getMethod(),
+            $request->getUrl(),
+
+            /** @todo This should depend on Vary: header */
+            $request->getHeader('Accept'),
+            $request->getHeader('Accept-Encoding'),
+            $request->getHeader('Authorization')
+        ]);
+
+        if ($cached = $this->cache->load($cacheKey)) {
+            if ($this->forbidRecheck) {
+                $cached = clone $cached;
+                $this->onResponse && call_user_func($this->onResponse, $cached);
+                return $cached;
+            }
+
+            /** @var $cached Response */
+            if ($cached->hasHeader('Last-Modified')) {
+                $request->addHeader('If-Modified-Since', $cached->getHeader('Last-Modified'));
+            }
+            if ($cached->hasHeader('ETag')) {
+                $request->addHeader('If-None-Match', $cached->getHeader('ETag'));
+            }
+        }
+
+        $response = $this->client->request($request);
+
+        if ($this->isCacheable($response)) {
+            $this->cache->save($cacheKey, clone $response);
+        }
+
+        if (isset($cached) && $response->getCode() === Response::S304_NOT_MODIFIED) {
+            $cached = clone $cached;
+
+            /** @todo Should be responses somehow combined into one? */
+            $response = $cached->setPrevious($response);
+        }
+
+        $this->onResponse && call_user_func($this->onResponse, $response);
+
+        return $response;
+    }
+
+
+    /**
+     * @param  callable|NULL function(Request $request)
+     * @return self
+     */
+    public function onRequest($callback)
+    {
+        $this->client->onRequest($callback);
+        return $this;
+    }
+
+
+    /**
+     * @param  callable|NULL function(Response $response)
+     * @return self
+     */
+    public function onResponse($callback)
+    {
+        $this->client->onResponse(NULL);
+        $this->onResponse = $callback;
+        return $this;
+    }
+
+
+    /**
+     * @return bool
+     */
+    protected function isCacheable(Response $response)
+    {
+        /** @todo Do it properly. Vary:, Pragma:, TTL...  */
+        if (!$response->isCode(200)) {
+            return FALSE;
+        } elseif (preg_match('#max-age=0|must-revalidate#i', $response->getHeader('Cache-Control', ''))) {
+            return FALSE;
+        }
+
+        return $response->hasHeader('ETag') || $response->hasHeader('Last-Modified');
+    }
 
 }

class/Github/Http/StreamClient.php

Indentation +103 added lines, -103 removed lines

@@ -10,108 +10,108 @@
  */
 class StreamClient extends AbstractClient
 {
-	/** @var array|NULL */
-	private $sslOptions;
-
-
-	/**
-	 * @param  array  SSL context options {@link http://php.net/manual/en/context.ssl.php}
-	 */
-	public function __construct(array $sslOptions = NULL)
-	{
-		$this->sslOptions = $sslOptions;
-	}
-
-
-	protected function setupRequest(Request $request)
-	{
-		parent::setupRequest($request);
-		$request->setHeader('Connection', 'close');
-	}
-
-
-	/**
-	 * @return Response
-	 *
-	 * @throws BadResponseException
-	 */
-	protected function process(Request $request)
-	{
-		$headerStr = [];
-		foreach ($request->getHeaders() as $name => $value) {
-			foreach ((array) $value as $v) {
-				$headerStr[] = "$name: $v";
-			}
-		}
-
-		$options = [
-			'http' => [
-				'method' => $request->getMethod(),
-				'header' => implode("\r\n", $headerStr) . "\r\n",
-				'follow_location' => 0,  # Github sets the Location header for 201 code too and redirection is not required for us
-				'protocol_version' => 1.1,
-				'ignore_errors' => TRUE,
-			],
-			'ssl' => [
-				'verify_peer' => TRUE,
-				'cafile' => realpath(__DIR__ . '/../../ca-chain.crt'),
-				'disable_compression' => TRUE,  # Effective since PHP 5.4.13
-			],
-		];
-
-		if (($content = $request->getContent()) !== NULL) {
-			$options['http']['content'] = $content;
-		}
-
-		if ($this->sslOptions) {
-			$options['ssl'] = $this->sslOptions + $options['ssl'];
-		}
-
-		list($code, $headers, $content) = $this->fileGetContents($request->getUrl(), $options);
-		return new Response($code, $headers, $content);
-	}
-
-
-	/**
-	 * @internal
-	 * @param  string
-	 * @param  array
-	 * @return array
-	 *
-	 * @throws BadResponseException
-	 */
-	protected function fileGetContents($url, array $contextOptions)
-	{
-		$context = stream_context_create($contextOptions);
-
-		$e = NULL;
-		set_error_handler(function($severity, $message, $file, $line) use (& $e) {
-			$e = new \ErrorException($message, 0, $severity, $file, $line, $e);
-		}, E_WARNING);
-
-		$content = file_get_contents($url, FALSE, $context);
-		restore_error_handler();
-
-		if (!isset($http_response_header)) {
-			throw new BadResponseException('Missing HTTP headers, request failed.', 0, $e);
-		}
-
-		if (!isset($http_response_header[0]) || !preg_match('~^HTTP/1[.]. (\d{3})~i', $http_response_header[0], $m)) {
-			throw new BadResponseException('HTTP status code is missing.', 0, $e);
-		}
-		unset($http_response_header[0]);
-
-		$headers = [];
-		foreach ($http_response_header as $header) {
-			if (in_array(substr($header, 0, 1), [' ', "\t"], TRUE)) {
-				$headers[$last] .= ' ' . trim($header);  # RFC2616, 2.2
-			} else {
-				list($name, $value) = explode(':', $header, 2) + [NULL, NULL];
-				$headers[$last = trim($name)] = trim($value);
-			}
-		}
-
-		return [$m[1], $headers, $content];
-	}
+    /** @var array|NULL */
+    private $sslOptions;
+
+
+    /**
+     * @param  array  SSL context options {@link http://php.net/manual/en/context.ssl.php}
+     */
+    public function __construct(array $sslOptions = NULL)
+    {
+        $this->sslOptions = $sslOptions;
+    }
+
+
+    protected function setupRequest(Request $request)
+    {
+        parent::setupRequest($request);
+        $request->setHeader('Connection', 'close');
+    }
+
+
+    /**
+     * @return Response
+     *
+     * @throws BadResponseException
+     */
+    protected function process(Request $request)
+    {
+        $headerStr = [];
+        foreach ($request->getHeaders() as $name => $value) {
+            foreach ((array) $value as $v) {
+                $headerStr[] = "$name: $v";
+            }
+        }
+
+        $options = [
+            'http' => [
+                'method' => $request->getMethod(),
+                'header' => implode("\r\n", $headerStr) . "\r\n",
+                'follow_location' => 0,  # Github sets the Location header for 201 code too and redirection is not required for us
+                'protocol_version' => 1.1,
+                'ignore_errors' => TRUE,
+            ],
+            'ssl' => [
+                'verify_peer' => TRUE,
+                'cafile' => realpath(__DIR__ . '/../../ca-chain.crt'),
+                'disable_compression' => TRUE,  # Effective since PHP 5.4.13
+            ],
+        ];
+
+        if (($content = $request->getContent()) !== NULL) {
+            $options['http']['content'] = $content;
+        }
+
+        if ($this->sslOptions) {
+            $options['ssl'] = $this->sslOptions + $options['ssl'];
+        }
+
+        list($code, $headers, $content) = $this->fileGetContents($request->getUrl(), $options);
+        return new Response($code, $headers, $content);
+    }
+
+
+    /**
+     * @internal
+     * @param  string
+     * @param  array
+     * @return array
+     *
+     * @throws BadResponseException
+     */
+    protected function fileGetContents($url, array $contextOptions)
+    {
+        $context = stream_context_create($contextOptions);
+
+        $e = NULL;
+        set_error_handler(function($severity, $message, $file, $line) use (& $e) {
+            $e = new \ErrorException($message, 0, $severity, $file, $line, $e);
+        }, E_WARNING);
+
+        $content = file_get_contents($url, FALSE, $context);
+        restore_error_handler();
+
+        if (!isset($http_response_header)) {
+            throw new BadResponseException('Missing HTTP headers, request failed.', 0, $e);
+        }
+
+        if (!isset($http_response_header[0]) || !preg_match('~^HTTP/1[.]. (\d{3})~i', $http_response_header[0], $m)) {
+            throw new BadResponseException('HTTP status code is missing.', 0, $e);
+        }
+        unset($http_response_header[0]);
+
+        $headers = [];
+        foreach ($http_response_header as $header) {
+            if (in_array(substr($header, 0, 1), [' ', "\t"], TRUE)) {
+                $headers[$last] .= ' ' . trim($header);  # RFC2616, 2.2
+            } else {
+                list($name, $value) = explode(':', $header, 2) + [NULL, NULL];
+                $headers[$last = trim($name)] = trim($value);
+            }
+        }
+
+        return [$m[1], $headers, $content];
+    }
 
 }