libs/phplibrary
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: Аннотации к типам

Browse source
This commit is contained in:
origami11@yandex.ru 2025-10-28 16:32:00 +03:00
parent 386a927254
commit 245b5c6c19
18 changed files with 191 additions and 104 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/Connection/HttpResponse.php
View file

@ -30,7 +30,7 @@ class HttpResponse
/**
* Обработка HTTP ответа
*/
private function parseMessage()
private function parseMessage(): void
{
$http = explode(" ", $this->getLine());
$this->version = $http[0];
@ -72,6 +72,7 @@ class HttpResponse
/**
* Значение параметра HTTP ответа
* @param string $name Имя параметра
*/
public function getParameter($name): string
{

55
src/Controller/Action.php
View file

@ -1,16 +1,18 @@
<?php
namespace ctiso\Controller;
use Exception,
ctiso\Path,
ctiso\Url,
ctiso\Model\Factory,
ctiso\HttpRequest,
ctiso\Settings,
ctiso\Database,
ctiso\View\Composite,
ctiso\View\View,
App\Controller\State;
use Exception;
use ctiso\Path;
use ctiso\Url;
use ctiso\Model\Factory;
use ctiso\HttpRequest;
use ctiso\Settings;
use ctiso\Database;
use ctiso\View\Composite;
use ctiso\View\View;
use App\Controller\State;
/**
* Контроллер страниц
*/
@ -37,6 +39,7 @@ class Action implements ActionInterface
// Фильтры
/** @var ?\ctiso\Filter\ActionAccess */
public $access = null; // Обьект хранит параметры доступа
/** @var ?\ctiso\Filter\ActionLogger */
public $logger = null; // Обьект для ведения лога
private $factory = null; // Ссылка на обьект создания модели
@ -100,7 +103,7 @@ class Action implements ActionInterface
* @param View $view
* @param string $name
*/
public function addSuggest(View $view, $name) {
public function addSuggest(View $view, $name): void {
$suggest = [];
$file = Path::join($this->modulePath, 'help', $name . '.suggest');
if (file_exists($file)) {
@ -188,6 +191,7 @@ class Action implements ActionInterface
* 1. Можно переопределить действия
* 2. Использовать наследование чтобы добавить к старому обработчику новое поведение
* @param HttpRequest $request запроса
* @return View|string
*/
public function preProcess(HttpRequest $request)
{
@ -203,6 +207,11 @@ class Action implements ActionInterface
return $view;
}
/**
* Выполнение действия
* @param HttpRequest $request
* @return View|string
*/
public function execute(HttpRequest $request)
{
$result = $this->preProcess($request);
@ -227,7 +236,7 @@ class Action implements ActionInterface
/**
* Страница по умолчанию
* @param HttpRequest $request
* @return string|\ctiso\View\View
* @return View|string
*/
public function actionIndex(HttpRequest $request) {
return "";
@ -355,14 +364,19 @@ class Action implements ActionInterface
/**
* Добавление widget к отображению
* @param $section
* @param $node
* @param string $section
* @param View $node
*/
public function addChild($section, $node): void
{
$this->childNodes[$section] = $node;
}
/**
* Установка значения контроллера
* @param string $name
* @param mixed $value
*/
public function setValue($name, $value): void
{
$this->ctrlValues[$name] = $value;
@ -370,6 +384,8 @@ class Action implements ActionInterface
/**
* Добавление дочернего отображения к текущему отображению
* @param string $section
* @param View $node
*/
public function addView($section, $node): void
{
@ -379,6 +395,7 @@ class Action implements ActionInterface
/**
* Генерация содержания
* Путаница c execute и render
* @return View|string
*/
public function render()
{
@ -426,16 +443,14 @@ class Action implements ActionInterface
return $result;
}
/**
* @return State
*/
function _getActionPath() {
return new State('index');
}
// Тоже убрать в метод Controller_Model
function getActionPath(HttpRequest $request, $action = null) {
$this->_getActionPath()->getPath($this, ($action) ? $action : $request->getAction());
}
function redirect(string $action) {
function redirect(string $action): void {
header('location: ' . $action);
exit();
}

11
src/Controller/Component.php
View file

@ -29,10 +29,17 @@ class FakeTemplate {
$this->_name = $name;
}
function __set($key, $value) {
/**
* @param string $key
* @param mixed $value
*/
function __set($key, $value): void {
$this->_data[$key] = $value;
}
/**
* @return string
*/
function execute() {
return json_encode($this->_data);
}
@ -56,7 +63,7 @@ class Component
public $component_id;
/** @var string */
public $component_title;
/** @var string */
public $COMPONENTS_WEB;
public Registry $config;

3
src/Controller/Service.php
View file

@ -20,8 +20,11 @@ class Service
public $webPath = [];
/** @var Registry */
public $config;
/** @var string */
public $template;
/** @var string */
public $templatePath;
/** @var string */
public $COMPONENTS_WEB;
/** @var Database */
public $db;

15
src/Controller/SiteInterface.php
View file

@ -4,15 +4,22 @@ namespace ctiso\Controller;
interface SiteInterface {
function getResource();
/**
* @return \ctiso\Database
*/
function getDatabase();
function getConfig();
function getTheme();
function addComponentConfig($config);
function addRequireJsPath(string $name, string $path, ?array $shim = null);
function addStyleSheet(string $url);
function addComponentConfig($config): void;
function addRequireJsPath(string $name, string $path, ?array $shim = null): void;
function addStyleSheet(string $url): void;
/**
* @param string $expression
* @return ?Component
*/
function loadComponent(string $expression);
function findTemplate(string $name);
function replaceImg(string $src, int $width, int $height);
function updatePageTime(int $time);
function updatePageTime(int $time): void;
}

8
src/Database.php
View file

@ -124,8 +124,8 @@ namespace ctiso {
/**
* Извлекает из базы все элементы по запросу (Для совместимости со старым представлением баз данных CIS)
* @param string $query - запрос
* @param array $values - значения
* @return array
* @param array<string, mixed> $values - значения
* @return list<array<string, mixed>>
*/
public function fetchAllArray($query, $values = null)
{
@ -138,8 +138,8 @@ namespace ctiso {
/**
* Извлекает из базы первый элемент по запросу
* @param string $query - запрос
* @param array $values - значения
* @return array|false
* @param array<string, mixed> $values - значения
* @return array<string, mixed>|false
*/
public function fetchOneArray($query, $values = null)
{

2
src/Database/Manager.php
View file

@ -294,7 +294,7 @@ class Manager
/**
* Возвращает все имена таблиц
* @return array
* @return list<string>
*/
public function getAllTableNames()
{

2
src/Form/OptionsFactory.php
View file

@ -3,5 +3,5 @@
namespace ctiso\Form;
interface OptionsFactory {
function create(Select $field, array $options);
function create(Select $field, array $options): void;
}

22
src/Functions.php
View file

@ -217,15 +217,29 @@ class Functions {
return ($a[$key] < $b[$key]) ? -1 : 1;
}
/**
* @deprecated
* @param string $name Метод
* @param object $o
*
* @return mixed
*/
static function __self($name, $o) {
return call_user_func([$o, $name]);
}
static function concat(/* $args ...*/) {
$args = func_get_args();
/**
* @param string ...$args
* @return string
*/
static function concat(...$args) {
return implode("", $args);
}
/**
* @param mixed $x
* @return bool
*/
static function __empty($x) {
return empty($x);
}
@ -235,7 +249,7 @@ class Functions {
* @example key_values('a', array(1 => array('a' => 1, 'b' => 2))) => array(1)
*
* @param string $key
* @param array|\ArrayIterator $array
* @param list<array>|\ArrayIterator $array
* @return mixed
*/
static function key_values($key, $array) {
@ -249,7 +263,7 @@ class Functions {
/**
* @param string $key
* @param array|\ArrayIterator $array
* @param list<object>|\ArrayIterator $array
*/
static function key_values_object($key, $array) {
$result = [];

7
src/Role/User.php
View file

@ -34,6 +34,9 @@ class User implements UserInterface
return $this->name;
}
/**
* @return bool
*/
function isLogged() {
return \ctiso\Filter\Authorization::isLogged();
}
@ -55,6 +58,10 @@ class User implements UserInterface
return null;
}
/**
* @param PDOStatement $result
* @return string
*/
function getUserPassword($result) {
return $result->get('password');
}

6
src/Setup.php
View file

@ -121,6 +121,8 @@ class Setup
/**
* Заменяет переменные на их значения в строке
* @param list<string> $match массив совпадения
* @return string
*/
function replaceVariable(array $match)
{
@ -132,12 +134,14 @@ class Setup
/**
* Для всех аттрибутов заменяет переменные на их значения
* @param SimpleXMLElement $attributes аттрибуты
* @return array<string, string>
*/
function resolve(SimpleXMLElement $attributes): array
{
$result = [];
foreach ($attributes as $key => $value) {
$result [$key] = preg_replace_callback("/\\\${(\w+)}/", [$this, 'replaceVariable'], $value);
$result[$key] = preg_replace_callback("/\\\${(\w+)}/", [$this, 'replaceVariable'], $value);
}
return $result;
}

27
src/Tales.php
View file

@ -4,12 +4,13 @@
* Расширения для PHPTAL для отображения времени и даты
*/
namespace ctiso;
use PHPTAL_Php_TalesInternal,
ctiso\Controller\SiteInterface,
ctiso\Controller\Component,
ctiso\HttpRequest,
PHPTAL_Tales,
PHPTAL_TalesRegistry;
use PHPTAL_Php_TalesInternal;
use ctiso\Controller\SiteInterface;
use ctiso\Controller\Component;
use ctiso\HttpRequest;
use PHPTAL_Tales;
use PHPTAL_TalesRegistry;
class Tales_DateTime implements PHPTAL_Tales
{
@ -61,8 +62,10 @@ class Tales {
/**
* Функция подключения компонента
* @param string $expression
* @return string
*/
static function phptal_component($expression) {
static function phptal_component($expression): string {
$begin = floatval(microtime(true));
/** @var Component */
$component = self::$site->loadComponent($expression);
@ -74,14 +77,14 @@ class Tales {
}
static function register(?SiteInterface $site) {
static function register(?SiteInterface $site): void {
self::$site = $site;
/* Регистрация нового префикса для подключения компонента */
$tales = PHPTAL_TalesRegistry::getInstance();
$tales->registerPrefix('component', ['ctiso\\Tales_Component', 'component']);
$tales->registerPrefix('date', ['ctiso\\Tales_DateTime', 'date']);
$tales->registerPrefix('time', ['ctiso\\Tales_DateTime', 'time']);
$tales->registerPrefix('assets', ['ctiso\\Tales_Assets', 'assets']);
$tales->registerPrefix('component', [\ctiso\Tales_Component::class, 'component']);
$tales->registerPrefix('date', [\ctiso\Tales_DateTime::class, 'date']);
$tales->registerPrefix('time', [\ctiso\Tales_DateTime::class, 'time']);
$tales->registerPrefix('assets', [\ctiso\Tales_Assets::class, 'assets']);
}
}

2
src/Tools/Drawing.php
View file

@ -18,7 +18,7 @@ class Drawing
* @param int $top
* @param int $width
* @param int $height
* @param array $rgb
* @param list<int> $rgb
*/
static function drawRectangle(GdImage &$image, int $left, int $top, int $width, int $height, array $rgb): void
{

106
src/Tools/SQLStatementExtractor.php
View file

@ -26,10 +26,13 @@
* @version $Revision: 1.5 $
* @package creole.util.sql
*/
namespace ctiso\Tools;
use Exception;
class SQLStatementExtractor {
class SQLStatementExtractor
{
protected static $delimiter = ';';
@ -39,10 +42,11 @@ class SQLStatementExtractor {
* @param string $filename Path to file to read.
* @return array SQL statements
*/
public static function extractFile($filename) {
public static function extractFile($filename)
{
$buffer = file_get_contents($filename);
if ($buffer !== false) {
return self::extractStatements(self::getLines($buffer));
return self::extractStatements(self::getLines($buffer));
}
throw new Exception("Unable to read file: " . $filename);
}
@ -53,50 +57,53 @@ class SQLStatementExtractor {
* @param string $buffer
* @return array
*/
public static function extract($buffer) {
public static function extract($buffer)
{
return self::extractStatements(self::getLines($buffer));
}
/**
* Extract SQL statements from array of lines.
*
* @param array $lines Lines of the read-in file.
* @return array
* @param list<string> $lines Lines of the read-in file.
* @return list<string>
*/
protected static function extractStatements($lines) {
protected static function extractStatements($lines)
{
$statements = [];
$sql = "";
foreach($lines as $line) {
foreach ($lines as $line) {
$line = trim($line);
$line = trim($line);
if (self::startsWith("//", $line) ||
self::startsWith("--", $line) ||
self::startsWith("#", $line)) {
continue;
}
if (strlen($line) > 4 && strtoupper(substr($line,0, 4)) == "REM ") {
continue;
}
$sql .= " " . $line;
$sql = trim($sql);
// SQL defines "--" as a comment to EOL
// and in Oracle it may contain a hint
// so we cannot just remove it, instead we must end it
if (strpos($line, "--") !== false) {
$sql .= "\n";
}
if (self::endsWith(self::$delimiter, $sql)) {
$statements[] = self::substring($sql, 0, strlen($sql)-1 - strlen(self::$delimiter));
$sql = "";
}
if (
self::startsWith("//", $line) ||
self::startsWith("--", $line) ||
self::startsWith("#", $line)
) {
continue;
}
if (strlen($line) > 4 && strtoupper(substr($line, 0, 4)) == "REM ") {
continue;
}
$sql .= " " . $line;
$sql = trim($sql);
// SQL defines "--" as a comment to EOL
// and in Oracle it may contain a hint
// so we cannot just remove it, instead we must end it
if (strpos($line, "--") !== false) {
$sql .= "\n";
}
if (self::endsWith(self::$delimiter, $sql)) {
$statements[] = self::substring($sql, 0, strlen($sql) - 1 - strlen(self::$delimiter));
$sql = "";
}
}
return $statements;
}
@ -110,7 +117,8 @@ class SQLStatementExtractor {
* @param string $string The string to check in (haystack).
* @return boolean True if $string starts with $check, or they are equal, or $check is empty.
*/
protected static function startsWith($check, $string) {
protected static function startsWith($check, $string)
{
if ($check === "" || $check === $string) {
return true;
} else {
@ -124,7 +132,8 @@ class SQLStatementExtractor {
* @param string $string The string to check in (haystack).
* @return boolean True if $string ends with $check, or they are equal, or $check is empty.
*/
protected static function endsWith(string $check, string $string) {
protected static function endsWith(string $check, string $string)
{
if ($check === "" || $check === $string) {
return true;
} else {
@ -136,21 +145,22 @@ class SQLStatementExtractor {
* a natural way of getting a subtring, php's circular string buffer and strange
* return values suck if you want to program strict as of C or friends
*/
protected static function substring(string $string, int $startpos, int $endpos = -1) {
protected static function substring(string $string, int $startpos, int $endpos = -1)
{
$len = strlen($string);
$endpos = (int) (($endpos === -1) ? $len-1 : $endpos);
if ($startpos > $len-1 || $startpos < 0) {
$endpos = (int) (($endpos === -1) ? $len - 1 : $endpos);
if ($startpos > $len - 1 || $startpos < 0) {
trigger_error("substring(), Startindex out of bounds must be 0<n<$len", E_USER_ERROR);
}
if ($endpos > $len-1 || $endpos < $startpos) {
trigger_error("substring(), Endindex out of bounds must be $startpos<n<".($len-1), E_USER_ERROR);
if ($endpos > $len - 1 || $endpos < $startpos) {
trigger_error("substring(), Endindex out of bounds must be $startpos<n<" . ($len - 1), E_USER_ERROR);
}
if ($startpos === $endpos) {
return (string) $string[$startpos];
} else {
$len = $endpos-$startpos;
$len = $endpos - $startpos;
}
return substr($string, $startpos, $len+1);
return substr($string, $startpos, $len + 1);
}
/**
@ -159,9 +169,9 @@ class SQLStatementExtractor {
* @param string $buffer
* @return string[] lines of file.
*/
protected static function getLines(string $buffer): array {
$lines = preg_split("/\r?\n|\r/", $buffer);
return $lines;
protected static function getLines(string $buffer): array
{
$lines = preg_split("/\r?\n|\r/", $buffer);
return $lines;
}
}
}

5
src/Validator/Rule/AbstractRule.php
View file

@ -32,6 +32,11 @@ abstract class AbstractRule
return $this->errorMsg;
}
/**
* @param Collection $container
* @param bool|null $status
* @return bool
*/
public function isValid(Collection $container, $status = null): bool
{
return true;

17
src/Validator/Validator.php
View file

@ -123,11 +123,17 @@ class Validator
$this->errorMsg = [];
}
public function validate(Collection $container, $rule = null, $status = null): bool
/**
* @param Collection $container
* @param AbstractRule[]|null $rules
* @param bool|null $status
* @return bool
*/
public function validate(Collection $container, $rules = null, $status = null): bool
{
$fields = [];
if ($rule) {
$this->chain = $rule;
if ($rules) {
$this->chain = $rules;
}
foreach ($this->chain as $rule) {
@ -156,7 +162,10 @@ class Validator
return empty($this->errorMsg);
}
public function getErrorMsg()
/**
* @return array<string, string>
*/
public function getErrorMsg(): array
{
return $this->errorMsg;
}

1
src/View/Top.php
View file

@ -147,5 +147,4 @@ class Top extends Composite
{
return $this->doTree('_stylesheet');
}
}

3
src/View/View.php
View file

@ -32,6 +32,7 @@ class View extends \stdClass
/** @var string[] $alias */
public array $alias = [];
public $codeGenerator = null;
/** @var View|null */
public $parent_view = null;
function __construct() {
@ -191,6 +192,8 @@ class View extends \stdClass
/**
* @param string[][] $alias
* @param string[] $list
* @return string[]
*/
public function resolveAllNames($alias, array $list): array {
$result = [];