zentao/lib/zin/core/jshelper.class.php

<?php
/**
 * The js helper class file of zin lib.
 *
 * @copyright   Copyright 2024 青岛易软天创网络科技有限公司(QingDao Nature Easy Soft Network Technology Co,LTD, www.cnezsoft.com)
 * @author      Hao Sun <sunhao@easycorp.ltd>
 * @package     zin
 * @version     $Id
 * @link        https://www.zentao.net
 */

namespace zin;

require_once __DIR__ . DS . 'js.class.php';
require_once __DIR__ . DS . 'jquery.class.php';

/**
 * Class for generating js code.
 * 用于生成 js 代码的助手，可以方便的操作 DOM 元素。
 */
class jsHelper extends js
{
    /**
     * Hide the specified elements.
     * 隐藏指定的元素。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @return self
     */
    public function toggleHide($selector)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.hide();");
    }

    /**
     * Toggle the specified elements, if not specified, auto detect.
     * 切换显示或隐藏指定的元素，如果不指定参数则自动判断。
     *
     * @access public
     * @param string $selector     The selector of the elements.
     * @param string $toggleCode   Whether to show or hide the elements.
     * @return self
     */
    public function toggleShow($selector, $toggleCode = null)
    {
        $target = jQuery::selector($selector);
        if(is_null($toggleCode)) return $this->appendLine("$target.toggle();");

        if(!is_string($toggleCode)) $toggleCode = json_encode($toggleCode);
        return $this->appendLine("$target.toggle($toggleCode);");
    }

    /**
     * Add class to the specified elements.
     * 给指定的元素添加 CSS 类。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $class    The class to add.
     * @return self
     */
    public function addClass($selector, $class)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.addClass(\"{$class}\");");
    }

    /**
     * Remove class from the specified elements.
     * 从指定的元素中移除 CSS 类。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $class    The class to remove.
     * @return self
     */
    public function removeClass($selector, $class)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.removeClass(\"{$class}\");");
    }

    /**
     * Toggle class of the specified elements.
     * 切换指定的元素的 CSS 类。
     *
     * @access public
     * @param string $selector     The selector of the elements.
     * @param string $class        The class to toggle.
     * @param string $toggleCode   Whether to add or remove the class.
     * @return self
     */
    public function toggleClass($selector, $class, $toggleCode = null)
    {
        $target = jQuery::selector($selector);
        if(is_null($toggleCode)) return $this->appendLine("$target.toggleClass(\"{$class}\");");
        return $this->appendLine("$target.toggleClass(\"{$class}\", $toggleCode);");
    }

    /**
     * Set the html of the specified elements.
     * 设置指定元素的 html。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $html     The html to set.
     * @return self
     */
    public function setHtml($selector, $html)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.html(", json_encode($html), ");");
    }

    /**
     * Set the text of the specified elements.
     * 设置指定元素的 text。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $text     The text to set.
     * @return self
     */
    public function setText($selector, $text)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.text(", json_encode($text), ");");
    }

    /**
     * Set the value of the specified elements.
     * 设置指定元素的 value。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $value    The value to set.
     * @return self
     */
    public function setVal($selector, $value)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.val(", json_encode($value), ");");
    }

    /**
     * Set the css of the specified elements.
     * 设置指定元素的 css。
     *
     * @access public
     * @param string $selector        The selector of the elements.
     * @param string $nameOrStyle     The name of the css or the css style object.
     * @param string $value           The value of the css.
     * @return self
     */
    public function setCss($selector, $nameOrStyle, $value = null)
    {
        $target = jQuery::selector($selector);
        if(is_array($nameOrStyle)) return $this->appendLine("$target.css(", json_encode($nameOrStyle), ");");
        return $this->appendLine("$target.css(\"{$nameOrStyle}\", ", json_encode($value), ");");
    }

    /**
     * Set the attr of the specified elements.
     * 设置指定元素的 attr。
     *
     * @access public
     * @param string $selector        The selector of the elements.
     * @param string $nameOrAttrs     The name of the attr or the attr object.
     * @param string $value           The value of the attr.
     * @return self
     */
    public function setAttr($selector, $nameOrAttrs, $value = null)
    {
        $target = jQuery::selector($selector);
        if(is_array($nameOrAttrs)) return $this->appendLine("$target.attr(", json_encode($nameOrAttrs), ");");
        return $this->appendLine("$target.attr(\"{$nameOrAttrs}\", ", json_encode($value), ");");
    }

    /**
     * Remove the attr of the specified elements.
     * 移除指定元素的 attr。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $name     The name of the attr.
     * @return self
     */
    public function removeAttr($selector, $name)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.removeAttr(\"{$name}\");");
    }

    /**
     * Set the prop of the specified elements.
     * 设置指定元素的 prop。
     *
     * @access public
     * @param string $selector        The selector of the elements.
     * @param string $nameOrProps     The name of the prop or the prop object.
     * @param string $value           The value of the prop.
     * @return self
     */
    public function setProp($selector, $nameOrProps, $value = null)
    {
        $target = jQuery::selector($selector);
        if(is_array($nameOrProps)) return $this->appendLine("$target.prop(", json_encode($nameOrProps), ");");
        return $this->appendLine("$target.prop(\"{$nameOrProps}\", ", json_encode($value), ");");
    }

    /**
     * Remove the prop of the specified elements.
     * 移除指定元素的 prop。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $name     The name of the prop.
     * @return self
     */
    public function removeProp($selector, $name)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.removeProp(\"{$name}\");");
    }

    /**
     * Trigger the specified event of the specified elements.
     * 触发指定元素的指定事件。
     *
     * @access public
     * @param string $selector The selector of the elements.
     * @param string $event    The event to trigger.
     * @param mixed $data The data to pass to the event handler.
     * @return self
     */
    public function triggerEvent($selector, $event, $data = null)
    {
        $target = jQuery::selector($selector);
        return $this->appendLine("$target.trigger(\"{$event}\", ", json_encode($data), ");");
    }

    /**
     * Bind the specified event to the specified elements.
     * 给指定元素绑定指定事件。
     *
     * @access public
     * @param string $selector          The selector of the elements.
     * @param string $event             The event to bind.
     * @param string $targetsOrHandler  The targets or handler to bind.
     * @param string $handler           The handler to bind.
     * @return self
     */
    public function onEvent($selector, $event, $targetsOrHandler, $handler = null)
    {
        if(is_null($handler))
        {
            $targets = null;
            $handler = $targetsOrHandler;
        }
        else
        {
            $targets = $targetsOrHandler;
        }
        $target = jQuery::selector($selector);

        if(is_null($targets))
        {
            return $this->appendLine("$target.on(\"{$event}\", {$handler});");
        }
        $targets = str_replace('"', '\\"', $targets);
        return $this->appendLine("$target.on(\"{$event}\", \"{$targets}\", {$handler});");
    }

    /**
     * Unbind the specified event from the specified elements.
     * 给指定元素解绑指定事件。
     *
     * @access public
     * @param string $selector          The selector of the elements.
     * @param string $event             The event to unbind.
     * @param string $targetsOrHandler  The targets or handler to unbind.
     * @param string $handler           The handler to unbind.
     * @return self
     */
    public function offEvent($selector, $event, $targetsOrHandler = null, $handler = null)
    {
        if(is_null($handler))
        {
            $targets = null;
            $handler = $targetsOrHandler;
        }
        else
        {
            $targets = $targetsOrHandler;
        }
        $target = jQuery::selector($selector);

        if(is_null($targets))
        {
            if(is_null($handler)) return $this->appendLine("$target.off(\"{$event}\");");
            return $this->appendLine("$target.off(\"{$event}\", {$handler});");
        }
        $targets = str_replace('"', '\\"', $targets);
        if(is_null($handler)) return $this->appendLine("$target.off(\"{$event}\", \"{$targets}\");");
        return $this->appendLine("$target.off(\"{$event}\", \"{$targets}\", {$handler});");
    }
}

/**
 * Create a new js helper.
 * 创建一个新的 js 助手。
 *
 * @access public
 * @param string|array|js|null ...$codes The codes to append.
 * @return jsHelper
 */
function jsHelper(...$codes)
{
    return new jsHelper(...$codes);
}