boc

---

แพ็คเกจนี้ล้าสมัยและจะไม่ได้รับการอัปเดต! ใช้ olifanton/interop แทน

---

BOC (Bag of Cells) PHP Serialization Library

พอร์ต PHP ของ tonweb-boc JS Library

การติดตั้ง

composer require olifanton/boc

เอกสาร

เริ่มต้น

ติดตั้งแพ็คเกจ olifanton/boc ผ่านนักแต่งเพลงและรวมสคริปต์อัตโนมัติ:

 <?php declare (strict_types= 1 );

require __DIR__ . " /vendor/autoload.php " ;

use Olifanton  Boc  BitString ;
use Olifanton  Boc  Cell ;

// Now you can use BoC classes

ชั้นเรียนห้องสมุด

• บิต
• ห้องขัง
• ชิ้น

---

OlifantonBocBitString

BitString เป็นคลาสที่ช่วยให้คุณจัดการข้อมูลไบนารี BitString เป็นหัวใจสำคัญของการเป็นตัวแทน PHP ของเซลล์ TVM BitString เป็นหน่วยความจำที่ได้รับการปรับให้เหมาะสมสำหรับการจัดเก็บข้อมูลไบนารี ภายใน Bitstring ใช้การใช้งานของ Uint8Array ที่จัดทำโดยแพ็คเกจ ajf/typed-arrays และใช้เป็นประเภทพื้นฐานสำหรับการถ่ายโอนข้อมูลไบนารีระหว่างส่วนหนึ่งของไลบรารี Olifanton

อินสแตนซ์ Bitstring ถูกสร้างขึ้นด้วยความยาวคงที่อย่างเคร่งครัด write% (writebit, writeuint, ... ) วิธีการย้ายเคอร์เซอร์ภายใน หากคุณพยายามเขียนค่าที่เกินความยาวของบิตฟรีข้อยกเว้น BitStringException จะถูกโยนลงไป

ตัวสร้าง Bitstring

 /**
 * @param int $length
 */
public function __construct( int $ length )

พารามิเตอร์:

• $length - ความยาวของ UINT8ARRAY ค่าเริ่มต้นสำหรับ TVM Cell: 1023 (เอกสาร)

วิธี Bitstring

getFreebits (): int

ส่งคืนความยาวบิตที่ไม่ได้ใช้งานบิต

GetusedBits (): int

ผลตอบแทนความยาวบิตที่ใช้แล้ว

GetusedBytes (): int

ผลตอบแทนที่ใช้ความยาวไบต์ของบิต

รับ (): บูล

 /**
 * @param int $n Position
 */
public function get( int $ n ): bool

ส่งคืนค่าบิตที่ตำแหน่ง $n

บน (): โมฆะ

 /**
 * @param int $n Position
 */
public function on( int $ n ): void

ตั้งค่าบิตเป็น 1 ที่ตำแหน่ง $n

ปิด (): โมฆะ

 /**
 * @param int $n Position
 */
public function off( int $ n ): void

ตั้งค่าบิตเป็น 0 ที่ตำแหน่ง $n

สลับ (): โมฆะ

 /**
 * @param int $n Position
 */
public function toggle( int $ n ): void

บิตสลับ (ผกผัน) บิตที่ตำแหน่ง $n

iterate (): Generator

ส่งคืนเครื่องกำเนิดไฟฟ้าของบิตที่ใช้แล้ว

ตัวอย่าง:

 <?php declare (strict_types= 1 );

use Olifanton  Boc  BitString ;

$ bs = new BitString ( 4 );
$ bs -> writeBit ( 1 );
$ bs -> writeBit ( 0 );
$ bs -> writeBit ( 1 );
$ bs -> writeBit ( 1 );

foreach ( $ bs -> iterate () as $ b ) {
    echo ( int ) $ b ;
}
// Prints "1011" 

Writebit (): เป็นโมฆะ

 /**
 * @param int|bool $b
 */
public function writeBit( int | bool $ b ): void

เขียนบิตและเพิ่มเคอร์เซอร์ภายในบิต

WriteBitarray (): เป็นโมฆะ

 /**
 * @param array<int | bool> $ba Array of bits
 */
public function writeBitArray( array $ ba ): void

เขียนอาร์เรย์ของบิต

ตัวอย่าง:

 <?php declare (strict_types= 1 );

use Olifanton  Boc  BitString ;

$ bs = new BitString ( 4 );
$ bs -> writeBitArray ([ 1 , false , 0 , true ]);

foreach ( $ bs -> iterate () as $ b ) {
    echo ( int ) $ b ;
}
// Prints "1001" 

writeuint (): เป็นโมฆะ

 /**
 * @param int|BrickMathBigInteger $number Unsigned integer
 * @param int $bitLength Integer size (8, 16, 32, ...)
 */
public function writeUint( int | BigInteger $ number , int $ bitLength ): void

เขียน $ bitlength-bit integer ที่ไม่ได้ลงชื่อ

Writeint (): เป็นโมฆะ

 /**
 * @param int|BrickMathBigInteger $number Signed integer
 * @param int $bitLength Integer size (8, 16, 32, ...)
 */
public function writeInt( int | BigInteger $ number , int $ bitLength ): void

เขียน $ bitlength-bit Integer

WRITEUINT8 (): เป็นโมฆะ

นามแฝงของวิธี writeUint() ที่มีค่าพารามิเตอร์ $ bitlength ที่กำหนดไว้ล่วงหน้า

WriteBytes (): เป็นโมฆะ

 /**
 * @param ajfTypedArraysUint8Array $ui8 Byte array
 */
public function writeBytes( Uint8Array $ ui8 ): void

เขียนอาร์เรย์ของจำนวนเต็ม 8 บิตที่ไม่ได้ลงชื่อ

Writestring (): เป็นโมฆะ

 /**
 * @param string $value
 */
public function writeString( string $ value ): void

เขียนสตริง UTF-8

writecoins (): เป็นโมฆะ

 /**
 * @param int|BrickMathBigInteger $amount
 */
public function writeCoins( int | BigInteger $ amount ): void ;

เขียนเหรียญใน nanotoncoins 1 ตัน === 1000000000 (10^9) nanotonCoins

writeaddress (): เป็นโมฆะ

 /**
 * @param OlifantonUtilsAddress|null $address TON Address
 */
public function writeAddress(? Address $ address ): void

เขียนที่อยู่ตัน ดูการใช้งานที่อยู่ในแพ็คเกจ Olifanton/Utils

Writebitstring (): เป็นโมฆะ

 /**
 * @param OlifantonBocBitString $anotherBitString BitString instance
 */
public function writeBitString( BitString $ anotherBitString ): void

เขียนบิตอีกครั้งกับบิตนี้

Clone (): Bitstring

โคลนนิ่งบิตนี้และส่งคืนอินสแตนซ์บิตใหม่

tohex (): สตริง

ส่งคืนสตริง HEX ของ Bitstring

getimmutablearray (): uint8array

ส่งคืนสำเนา Uint8Array ภายในที่ไม่เปลี่ยนรูป

getLength (): int

ส่งคืนขนาดของบิตในบิต

---

OlifantonBocCell

Cell เป็นคลาสที่ใช้แนวคิดของเซลล์ TVM ใน PHP ในการสร้างข้อความใหม่และกระบวนการที่ได้รับจาก blockchain คุณจะทำงานกับอินสแตนซ์ของคลาสเซลล์

ตัวสร้าง เซลล์

ไม่มีพารามิเตอร์

วิธีการ เซลล์

FromBoc (): Array <Sell>

 /**
 * @param string|Uint8Array $serializedBoc Serialized BoC
 * @return Cell[]
 */
public static function fromBoc( string | Uint8Array $ serializedBoc ): array

สร้างอาร์เรย์ของเซลล์จากอาร์เรย์ไบต์หรือสตริง hex

OneFromboc (): เซลล์

 /**
 * @param string|Uint8Array $serializedBoc Serialized BoC
 * @param bool $isBase64 Base64-serialized flag, default false
 */
public static function oneFromBoc( string | Uint8Array $ serializedBoc , bool $ isBase64 = false ): Cell

ดึงหนึ่งเซลล์รูทจากอาร์เรย์ไบต์หรือสตริง hex

writecell (): เป็นโมฆะ

 /**
 * @param Cell $anotherCell Another cell
 * @return Cell This Cell
 */
public function writeCell( Cell $ anotherCell ): self

เขียนเซลล์อื่นไปยังเซลล์นี้และส่งคืนเซลล์นี้ วิธีที่ไม่แน่นอน

getMaxDepth (): int

ส่งคืนความลึกสูงสุดของเซลล์เด็ก

getBits (): Bitstring

ส่งคืนอินสแตนซ์ bitstring ภายในสำหรับการเขียนและการอ่าน

getRefs (): ArrayObject <Sell>

ส่งคืนวัตถุคล้ายอาเรย์ของเซลล์เด็ก

hash (): uint8array

ส่งคืนแฮช sha-256 ของเซลล์นี้

พิมพ์ (): สตริง

พิมพ์เนื้อหาของเซลล์ซ้ำเช่น FIFT

toboc (): uint8array

 /**
 * @param bool $has_idx Default _true_
 * @param bool $hash_crc32 Default _true_
 * @param bool $has_cache_bits Default _false_
 * @param int $flags Default _0_
 */
public function toBoc( bool $ has_idx = true ,
                      bool $ hash_crc32 = true ,
                      bool $ has_cache_bits = false ,
                      int  $ flags = 0 ): Uint8Array

สร้างอาร์เรย์ BOC BYTE

---

OlifantonBocSlice

Slice เป็นประเภทของชิ้นเซลล์ เซลล์สามารถแปลงเป็นชิ้นและจากนั้นบิตข้อมูลและการอ้างอิงไปยังเซลล์อื่น ๆ จากเซลล์สามารถรับได้โดยการโหลดจากชิ้น

load% (loadbit, loaduint, ... ) วิธีการเลื่อนเคอร์เซอร์ภายในชิ้น หากคุณพยายามอ่านค่าที่เกินความยาวของบิตฟรียกเว้น SliceException จะถูกโยนทิ้ง

เครื่องสร้าง ชิ้น

 /**
 * @param ajfTypedArraysUint8Array $array
 * @param int $length
 * @param OlifantonBocSlice[] $refs
 */
public function __construct( Uint8Array $ array , int $ length , array $ refs )

พารามิเตอร์:

• $array - uint8array จากการเป็นตัวแทนของเซลล์
• $length - ความยาวบิต
• $refs - เซลล์เด็กชิ้น

วิธี ชิ้น

getFreebits (): int

ส่งคืนบิตที่ยังไม่ได้อ่านตามเคอร์เซอร์ภายใน

รับ (): บูล

 /**
 * @param int $n
 */
public function get( int $ n ): bool

ส่งคืนค่าบิตที่ตำแหน่ง $n

loadbit (): บูล

อ่านเล็กน้อยและย้ายเคอร์เซอร์

loadbits (): uint8array

 /**
 * @param int $bitLength
 */
public function loadBits( int $ bitLength ): Uint8Array

อ่านอาร์เรย์บิต

loaduint (): biginteger

 /**
 * @param int $bitLength
 */
public function loadUint( int $ bitLength ): BigInteger

อ่านจำนวนเต็มที่ไม่ได้ลงชื่อ

loadint (): biginteger

 /**
 * @param int $bitLength
 */
public function loadInt( int $ bitLength ): BigInteger

อ่านจำนวนเต็มที่ลงนาม

loadvaruint (): biginteger

 /**
 * @param int $bitLength
 */
public function loadVarUint( int $ bitLength ): BigInteger 

loadcoins (): biginteger

อ่านจำนวนมากใน nanotoncoins

loadaddress ():? ที่อยู่

อ่านที่อยู่

loadref (): slice

อ่านเซลล์ลูกชิ้น

---

การทดสอบ

composer run test

---

ใบอนุญาต

มิกซ์