~ubuntu-branches/ubuntu/natty/bluefish/natty-proposed : revision 3

1

2

3

4

<description>Terminate apache process after this request</description>

5

6

<insert>apache_child_terminate();</insert>

7

<dialog title="Insert apache_child_terminate">apache_child_terminate();</dialog>

8

9

</function>

10

11

12

Perform a partial request for the specified URI and return all

13

info about it

14

</description>

15

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

16

<return type="object">object</return>

17

<insert>apache_lookup_uri(string filename);</insert>

18

<dialog title="Insert apache_lookup_uri">apache_lookup_uri(%0);</dialog>

19

20

</function>

21

22

<description>Get and set apache request notes</description>

23

24

<param name="note_value" required="0" vallist="0" default="" type="string">note_value</param>

25

<return type="string">string</return>

26

<insert>apache_note(string note_name [,string note_value]);</insert>

27

<dialog title="Insert apache_note">apache_note(%0, %1);</dialog>

28

29

</function>

30

31

<description>Fetch all HTTP request headers</description>

32

<return type="array">array</return>

33

<insert>apache_request_headers();</insert>

34

<dialog title="Insert apache_request_headers">apache_request_headers();</dialog>

35

36

</function>

37

38

39

Fetch all HTTP response headers

40

</description>

41

<return type="array">array</return>

42

<insert>apache_response_headers();</insert>

43

<dialog title="Insert apache_response_headers">apache_response_headers();</dialog>

44

45

</function>

46

47

<description>Set an Apache subprocess_env variable</description>

48

<param name="variable" required="1" vallist="0" default="" type="string">variable</param>

49

<param name="value" required="1" vallist="0" default="" type="string">value</param>

50

51

52

<insert>apache_setenv(string variable, string value [,bool walk_to_top]);</insert>

53

<dialog title="Insert apache_setenv">apache_setenv(%0, %1, %2);</dialog>

54

55

</function>

56

57

<description>Translate string from ASCII to EBCDIC</description>

58

<param name="ascii_str" required="1" vallist="0" default="" type="string">ascii_str</param>

59

60

<insert>ascii2ebcdic(string ascii_str);</insert>

61

<dialog title="Insert ascii2ebcdic">ascii2ebcdic(%0);</dialog>

62

63

</function>

64

65

<description>Translate string from EBCDIC to ASCII</description>

66

<param name="ebcdic_str" required="1" vallist="0" default="" type="string">ebcdic_str</param>

67

68

<insert>ebcdic2ascii(string ebcdic_str);</insert>

69

<dialog title="Insert ebcdic2ascii">ebcdic2ascii(%0);</dialog>

70

71

</function>

72

73

<description>Fetch all HTTP request headers</description>

74

<return type="array">array</return>

75

<insert>getallheaders();</insert>

76

<dialog title="Insert getallheaders">getallheaders();</dialog>

77

78

</function>

79

80

<description>Perform an Apache sub-request</description>

81

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

82

83

<insert>virtual(string filename);</insert>

84

<dialog title="Insert virtual">virtual(%0);</dialog>

85

86

</function>

87

</group>

88

89

90

<description>Returns an array with all string keys lowercased or uppercased</description>

91

<param name="input" required="1" vallist="0" default="" type="array">input</param>

92

93

<return type="array">array</return>

94

<insert>array_change_key_case(array input [,int case]);</insert>

95

<dialog title="Insert array_change_key_case">array_change_key_case(%0, %1);</dialog>

96

97

</function>

98

99

<description>Split an array into chunks</description>

100

<param name="input" required="1" vallist="0" default="" type="array">input</param>

101

102

<param name="preserve_keys" required="0" vallist="0" default="" type="bool">preserve_keys</param>

103

<return type="array">array</return>

104

<insert>array_chunk(array input, int size [,bool preserve_keys]);</insert>

105

<dialog title="Insert array_chunk">array_chunk(%0, %1, %2);</dialog>

106

107

</function>

108

109

<description>Counts all the values of an array</description>

110

<param name="input" required="1" vallist="0" default="" type="array">input</param>

111

<return type="array">array</return>

112

<insert>array_count_values(array input);</insert>

113

<dialog title="Insert array_count_values">array_count_values(%0);</dialog>

114

115

</function>

116

117

<description>Computes the difference of arrays with additional index check</description>

118

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

119

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

120

121

<return type="array">array</return>

122

<insert>array_diff_assoc(array array1, array array2 [,array ...]);</insert>

123

<dialog title="Insert array_diff_assoc">array_diff_assoc(%0, %1, %2);</dialog>

124

125

</function>

126

127

<description>Computes the difference of arrays</description>

128

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

129

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

130

131

<return type="array">array</return>

132

<insert>array_diff(array array1, array array2 [,array ...]);</insert>

133

<dialog title="Insert array_diff">array_diff(%0, %1, %2);</dialog>

134

135

</function>

136

137

<description>Fill an array with values</description>

138

<param name="start_index" required="1" vallist="0" default="" type="int">start_index</param>

139

140

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

141

<return type="array">array</return>

142

<insert>array_fill(int start_index, int num, mixed value);</insert>

143

<dialog title="Insert array_fill">array_fill(%0, %1, %2);</dialog>

144

145

</function>

146

147

148

Filters elements of an array using a callback function

149

</description>

150

<param name="input" required="1" vallist="0" default="" type="array">input</param>

151

<param name="function" required="0" vallist="0" default="" type="callback">function</param>

152

<return type="array">array</return>

153

<insert>array_filter(array input [,callback function]);</insert>

154

<dialog title="Insert array_filter">array_filter(%0, %1);</dialog>

155

156

</function>

157

158

<description>Exchanges all keys with their associated values in an array</description>

159

<param name="trans" required="1" vallist="0" default="" type="array">trans</param>

160

<return type="array">array</return>

161

<insert>array_flip(array trans);</insert>

162

<dialog title="Insert array_flip">array_flip(%0);</dialog>

163

164

</function>

165

166

<description>Computes the intersection of arrays with additional index check</description>

167

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

168

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

169

170

<return type="array">array</return>

171

<insert>array_intersect_assoc(array array1, array array2 [,array ...]);</insert>

172

<dialog title="Insert array_intersect_assoc">array_intersect_assoc(%0, %1, %2);</dialog>

173

174

</function>

175

176

<description>Computes the intersection of arrays</description>

177

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

178

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

179

180

<return type="array">array</return>

181

<insert>array_intersect(array array1, array array2 [,array ...]);</insert>

182

<dialog title="Insert array_intersect">array_intersect(%0, %1, %2);</dialog>

183

184

</function>

185

186

<description>Checks if the given key or index exists in the array</description>

187

188

<param name="search" required="1" vallist="0" default="" type="array">search</param>

189

190

<insert>array_key_exists(mixed key, array search);</insert>

191

<dialog title="Insert array_key_exists">array_key_exists(%0, %1);</dialog>

192

193

</function>

194

195

<description>Return all the keys of an array</description>

196

<param name="input" required="1" vallist="0" default="" type="array">input</param>

197

<param name="

198

search_value

199

" required="0" vallist="0" default="" type="mixed">

200

search_value

201

</param>

202

<return type="array">array</return>

203

<insert>array_keys(array input [,mixed

204

search_value

205

]);</insert>

206

<dialog title="Insert array_keys">array_keys(%0, %1);</dialog>

207

208

</function>

209

210

211

Applies the callback to the elements of the given arrays

212

</description>

213

<param name="callback" required="1" vallist="0" default="" type="mixed">callback</param>

214

215

216

<return type="array">array</return>

217

<insert>array_map(mixed callback, array arr1 [,array ...]);</insert>

218

<dialog title="Insert array_map">array_map(%0, %1, %2);</dialog>

219

220

</function>

221

222

<description>Merge two or more arrays recursively</description>

223

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

224

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

225

226

<return type="array">array</return>

227

<insert>array_merge_recursive(array array1, array array2 [,array ...]);</insert>

228

<dialog title="Insert array_merge_recursive">array_merge_recursive(%0, %1, %2);</dialog>

229

230

</function>

231

232

<description>Merge two or more arrays</description>

233

<param name="array1" required="1" vallist="0" default="" type="array">array1</param>

234

<param name="array2" required="1" vallist="0" default="" type="array">array2</param>

235

236

<return type="array">array</return>

237

<insert>array_merge(array array1, array array2 [,array ...]);</insert>

238

<dialog title="Insert array_merge">array_merge(%0, %1, %2);</dialog>

239

240

</function>

241

242

<description>Sort multiple or multi-dimensional arrays</description>

243

244

245

246

247

248

<insert>array_multisort(array ar1 [,mixed arg] [,mixed ...] [,array ...]);</insert>

249

<dialog title="Insert array_multisort">array_multisort(%0, %1, %2, %3);</dialog>

250

251

</function>

252

253

254

Pad array to the specified length with a value

255

</description>

256

<param name="input" required="1" vallist="0" default="" type="array">input</param>

257

258

<param name="pad_value" required="1" vallist="0" default="" type="mixed">pad_value</param>

259

<return type="array">array</return>

260

<insert>array_pad(array input, int pad_size, mixed pad_value);</insert>

261

<dialog title="Insert array_pad">array_pad(%0, %1, %2);</dialog>

262

263

</function>

264

265

<description>Pop the element off the end of array</description>

266

<param name="array" required="1" vallist="0" default="" type="array">array</param>

267

<return type="mixed">mixed</return>

268

<insert>array_pop(array array);</insert>

269

<dialog title="Insert array_pop">array_pop(%0);</dialog>

270

271

</function>

272

273

274

Push one or more elements onto the end of array

275

</description>

276

<param name="array" required="1" vallist="0" default="" type="array">array</param>

277

278

279

280

<insert>array_push(array array, mixed var [,mixed ...]);</insert>

281

<dialog title="Insert array_push">array_push(%0, %1, %2);</dialog>

282

283

</function>

284

285

286

Pick one or more random entries out of an array

287

</description>

288

<param name="input" required="1" vallist="0" default="" type="array">input</param>

289

290

<return type="mixed">mixed</return>

291

<insert>array_rand(array input [,int num_req]);</insert>

292

<dialog title="Insert array_rand">array_rand(%0, %1);</dialog>

293

294

</function>

295

296

297

Iteratively reduce the array to a single value using a callback

298

function

299

</description>

300

<param name="input" required="1" vallist="0" default="" type="array">input</param>

301

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

302

<param name="initial" required="0" vallist="0" default="" type="int">initial</param>

303

<return type="mixed">mixed</return>

304

<insert>array_reduce(array input, callback function [,int initial]);</insert>

305

<dialog title="Insert array_reduce">array_reduce(%0, %1, %2);</dialog>

306

307

</function>

308

309

310

Return an array with elements in reverse order

311

</description>

312

<param name="array" required="1" vallist="0" default="" type="array">array</param>

313

<param name="preserve_keys" required="0" vallist="0" default="" type="bool">preserve_keys</param>

314

<return type="array">array</return>

315

<insert>array_reverse(array array [,bool preserve_keys]);</insert>

316

<dialog title="Insert array_reverse">array_reverse(%0, %1);</dialog>

317

318

</function>

319

320

321

Searches the array for a given value and returns the

322

corresponding key if successful

323

</description>

324

<param name="needle" required="1" vallist="0" default="" type="mixed">needle</param>

325

<param name="haystack" required="1" vallist="0" default="" type="array">haystack</param>

326

<param name="strict" required="0" vallist="0" default="" type="bool">strict</param>

327

<return type="mixed">mixed</return>

328

<insert>array_search(mixed needle, array haystack [,bool strict]);</insert>

329

<dialog title="Insert array_search">array_search(%0, %1, %2);</dialog>

330

331

</function>

332

333

334

Shift an element off the beginning of array

335

</description>

336

<param name="array" required="1" vallist="0" default="" type="array">array</param>

337

<return type="mixed">mixed</return>

338

<insert>array_shift(array array);</insert>

339

<dialog title="Insert array_shift">array_shift(%0);</dialog>

340

341

</function>

342

343

<description>Extract a slice of the array</description>

344

<param name="array" required="1" vallist="0" default="" type="array">array</param>

345

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

346

<param name="

347

length

348

" required="0" vallist="0" default="" type="int">

349

length

350

</param>

351

<return type="array">array</return>

352

<insert>array_slice(array array, int offset [,int

353

length

354

]);</insert>

355

<dialog title="Insert array_slice">array_slice(%0, %1, %2);</dialog>

356

357

</function>

358

359

360

Remove a portion of the array and replace it with something

361

else

362

</description>

363

<param name="input" required="1" vallist="0" default="" type="array">input</param>

364

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

365

<param name="length" required="0" vallist="0" default="" type="int">length</param>

366

<param name="

367

replacement

368

" required="0" vallist="0" default="" type="array">

369

replacement

370

</param>

371

<return type="array">array</return>

372

<insert>array_splice(array input, int offset [,int length] [,array

373

replacement

374

]);</insert>

375

<dialog title="Insert array_splice">array_splice(%0, %1, %2, %3);</dialog>

376

377

</function>

378

379

380

Calculate the sum of values in an array.

381

</description>

382

<param name="array" required="1" vallist="0" default="" type="array">array</param>

383

<return type="mixed">mixed</return>

384

<insert>array_sum(array array);</insert>

385

<dialog title="Insert array_sum">array_sum(%0);</dialog>

386

387

</function>

388

389

<description>Removes duplicate values from an array</description>

390

<param name="array" required="1" vallist="0" default="" type="array">array</param>

391

<return type="array">array</return>

392

<insert>array_unique(array array);</insert>

393

<dialog title="Insert array_unique">array_unique(%0);</dialog>

394

395

</function>

396

397

398

Prepend one or more elements to the beginning of array

399

</description>

400

<param name="array" required="1" vallist="0" default="" type="array">array</param>

401

402

<param name="

403

...

404

" required="0" vallist="0" default="" type="mixed">

405

...

406

</param>

407

408

<insert>array_unshift(array array, mixed var [,mixed

409

...

410

]);</insert>

411

<dialog title="Insert array_unshift">array_unshift(%0, %1, %2);</dialog>

412

413

</function>

414

415

<description>Return all the values of an array</description>

416

<param name="input" required="1" vallist="0" default="" type="array">input</param>

417

<return type="array">array</return>

418

<insert>array_values(array input);</insert>

419

<dialog title="Insert array_values">array_values(%0);</dialog>

420

421

</function>

422

423

424

Apply a user function to every member of an array

425

</description>

426

<param name="array" required="1" vallist="0" default="" type="array">array</param>

427

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

428

<param name="userdata" required="0" vallist="0" default="" type="mixed">userdata</param>

429

430

<insert>array_walk(array array, callback function [,mixed userdata]);</insert>

431

<dialog title="Insert array_walk">array_walk(%0, %1, %2);</dialog>

432

433

</function>

434

435

436

Create an array

437

</description>

438

439

<return type="array">array</return>

440

<insert>array([mixed ...]);</insert>

441

<dialog title="Insert array">array(%0);</dialog>

442

443

</function>

444

445

446

Sort an array in reverse order and maintain index association

447

</description>

448

<param name="array" required="1" vallist="0" default="" type="array">array</param>

449

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

450

451

<insert>arsort(array array [,int sort_flags]);</insert>

452

<dialog title="Insert arsort">arsort(%0, %1);</dialog>

453

454

</function>

455

456

<description>Sort an array and maintain index association</description>

457

<param name="array" required="1" vallist="0" default="" type="array">array</param>

458

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

459

460

<insert>asort(array array [,int sort_flags]);</insert>

461

<dialog title="Insert asort">asort(%0, %1);</dialog>

462

463

</function>

464

465

466

Create array containing variables and their values

467

</description>

468

<param name="varname" required="1" vallist="0" default="" type="mixed">varname</param>

469

470

<return type="array">array</return>

471

<insert>compact(mixed varname [,mixed ...]);</insert>

472

<dialog title="Insert compact">compact(%0, %1);</dialog>

473

474

</function>

475

476

<description>Count elements in a variable</description>

477

478

479

<insert>count(mixed var);</insert>

480

<dialog title="Insert count">count(%0);</dialog>

481

482

</function>

483

484

<description>Return the current element in an array</description>

485

<param name="array" required="1" vallist="0" default="" type="array">array</param>

486

<return type="mixed">mixed</return>

487

<insert>current(array array);</insert>

488

<dialog title="Insert current">current(%0);</dialog>

489

490

</function>

491

492

493

Return the current key and value pair from an array and advance

494

the array cursor

495

</description>

496

<param name="array" required="1" vallist="0" default="" type="array">array</param>

497

<return type="array">array</return>

498

<insert>each(array array);</insert>

499

500

501

</function>

502

503

504

Set the internal pointer of an array to its last element

505

</description>

506

<param name="array" required="1" vallist="0" default="" type="array">array</param>

507

<return type="mixed">mixed</return>

508

<insert>end(array array);</insert>

509

510

511

</function>

512

513

514

Import variables into the current symbol table from an array

515

</description>

516

<param name="var_array" required="1" vallist="0" default="" type="array">var_array</param>

517

<param name="extract_type" required="0" vallist="0" default="" type="int">extract_type</param>

518

<param name="prefix" required="0" vallist="0" default="" type="string">prefix</param>

519

520

<insert>extract(array var_array [,int extract_type] [,string prefix]);</insert>

521

<dialog title="Insert extract">extract(%0, %1, %2);</dialog>

522

523

</function>

524

525

<description>Return </description>

526

<param name="needle" required="1" vallist="0" default="" type="mixed">needle</param>

527

<param name="haystack" required="1" vallist="0" default="" type="array">haystack</param>

528

<param name="strict" required="0" vallist="0" default="" type="bool">strict</param>

529

530

<insert>in_array(mixed needle, array haystack [,bool strict]);</insert>

531

<dialog title="Insert in_array">in_array(%0, %1, %2);</dialog>

532

533

</function>

534

535

<description>Fetch a key from an associative array</description>

536

<param name="array" required="1" vallist="0" default="" type="array">array</param>

537

<return type="mixed">mixed</return>

538

<insert>key(array array);</insert>

539

540

541

</function>

542

543

<description>Sort an array by key in reverse order</description>

544

<param name="array" required="1" vallist="0" default="" type="array">array</param>

545

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

546

547

<insert>krsort(array array [,int sort_flags]);</insert>

548

<dialog title="Insert krsort">krsort(%0, %1);</dialog>

549

550

</function>

551

552

<description>Sort an array by key</description>

553

<param name="array" required="1" vallist="0" default="" type="array">array</param>

554

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

555

556

<insert>ksort(array array [,int sort_flags]);</insert>

557

<dialog title="Insert ksort">ksort(%0, %1);</dialog>

558

559

</function>

560

561

562

Assign variables as if they were an array

563

</description>

564

565

566

<insert>list(mixed ...);</insert>

567

568

569

</function>

570

571

572

Sort an array using a case insensitive "natural order" algorithm

573

</description>

574

<param name="array" required="1" vallist="0" default="" type="array">array</param>

575

576

<insert>natcasesort(array array);</insert>

577

<dialog title="Insert natcasesort">natcasesort(%0);</dialog>

578

579

</function>

580

581

582

Sort an array using a "natural order" algorithm

583

</description>

584

<param name="array" required="1" vallist="0" default="" type="array">array</param>

585

586

<insert>natsort(array array);</insert>

587

<dialog title="Insert natsort">natsort(%0);</dialog>

588

589

</function>

590

591

592

Advance the internal array pointer of an array

593

</description>

594

<param name="array" required="1" vallist="0" default="" type="array">array</param>

595

<return type="mixed">mixed</return>

596

<insert>next(array array);</insert>

597

598

599

</function>

600

601

<description>Get the current element from an array</description>

602

<param name="array" required="1" vallist="0" default="" type="array">array</param>

603

<return type="mixed">mixed</return>

604

<insert>pos(array array);</insert>

605

606

607

</function>

608

609

<description>Rewind the internal array pointer</description>

610

<param name="array" required="1" vallist="0" default="" type="array">array</param>

611

<return type="mixed">mixed</return>

612

<insert>prev(array array);</insert>

613

614

615

</function>

616

617

618

Create an array containing a range of elements

619

</description>

620

621

622

623

<return type="array">array</return>

624

<insert>range(int low, int high [,int step]);</insert>

625

<dialog title="Insert range">range(%0, %1, %2);</dialog>

626

627

</function>

628

629

630

Set the internal pointer of an array to its first element

631

</description>

632

<param name="array" required="1" vallist="0" default="" type="array">array</param>

633

<return type="mixed">mixed</return>

634

<insert>reset(array array);</insert>

635

<dialog title="Insert reset">reset(%0);</dialog>

636

637

</function>

638

639

<description>Sort an array in reverse order</description>

640

<param name="array" required="1" vallist="0" default="" type="array">array</param>

641

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

642

643

<insert>rsort(array array [,int sort_flags]);</insert>

644

<dialog title="Insert rsort">rsort(%0, %1);</dialog>

645

646

</function>

647

648

<description>Shuffle an array</description>

649

<param name="array" required="1" vallist="0" default="" type="array">array</param>

650

651

<insert>shuffle(array array);</insert>

652

<dialog title="Insert shuffle">shuffle(%0);</dialog>

653

654

</function>

655

656

<description>Sort an array</description>

657

<param name="array" required="1" vallist="0" default="" type="array">array</param>

658

<param name="sort_flags" required="0" vallist="0" default="" type="int">sort_flags</param>

659

660

<insert>sort(array array [,int sort_flags]);</insert>

661

662

663

</function>

664

665

666

Sort an array with a user-defined comparison function and

667

maintain index association

668

</description>

669

<param name="array" required="1" vallist="0" default="" type="array">array</param>

670

<param name="cmp_function" required="1" vallist="0" default="" type="callback">cmp_function</param>

671

672

<insert>uasort(array array, callback cmp_function);</insert>

673

<dialog title="Insert uasort">uasort(%0, %1);</dialog>

674

675

</function>

676

677

678

Sort an array by keys using a user-defined comparison function

679

</description>

680

<param name="array" required="1" vallist="0" default="" type="array">array</param>

681

<param name="cmp_function" required="1" vallist="0" default="" type="callback">cmp_function</param>

682

683

<insert>uksort(array array, callback cmp_function);</insert>

684

<dialog title="Insert uksort">uksort(%0, %1);</dialog>

685

686

</function>

687

688

689

Sort an array by values using a user-defined comparison function

690

</description>

691

<param name="array" required="1" vallist="0" default="" type="array">array</param>

692

<param name="cmp_function" required="1" vallist="0" default="" type="callback">cmp_function</param>

693

694

<insert>usort(array array, callback cmp_function);</insert>

695

<dialog title="Insert usort">usort(%0, %1);</dialog>

696

697

</function>

698

</group>

699

700

701

702

Check a word without changing its case or trying to trim it [deprecated]

703

</description>

704

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

705

706

707

<insert>aspell_check_raw(int dictionary_link, string word);</insert>

708

<dialog title="Insert aspell_check_raw">aspell_check_raw(%0, %1);</dialog>

709

710

</function>

711

712

<description>Check a word [deprecated]</description>

713

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

714

715

716

<insert>aspell_check(int dictionary_link, string word);</insert>

717

<dialog title="Insert aspell_check">aspell_check(%0, %1);</dialog>

718

719

</function>

720

721

<description>Load a new dictionary [deprecated]</description>

722

<param name="master" required="1" vallist="0" default="" type="string">master</param>

723

<param name="personal" required="0" vallist="0" default="" type="string">personal</param>

724

725

<insert>aspell_new(string master [,string personal]);</insert>

726

<dialog title="Insert aspell_new">aspell_new(%0, %1);</dialog>

727

728

</function>

729

730

<description>Suggest spellings of a word [deprecated]</description>

731

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

732

733

<return type="array">array</return>

734

<insert>aspell_suggest(int dictionary_link, string word);</insert>

735

<dialog title="Insert aspell_suggest">aspell_suggest(%0, %1);</dialog>

736

737

</function>

738

</group>

739

740

741

<description>Add two arbitrary precision numbers</description>

742

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

743

<param name="right_operand" required="1" vallist="0" default="" type="string">right_operand</param>

744

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

745

<return type="string">string</return>

746

<insert>bcadd(string left_operand, string right_operand [,int scale]);</insert>

747

<dialog title="Insert bcadd">bcadd(%0, %1, %2);</dialog>

748

749

</function>

750

751

<description>Compare two arbitrary precision numbers</description>

752

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

753

<param name="right_operand" required="1" vallist="0" default="" type="string">right_operand</param>

754

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

755

756

<insert>bccomp(string left_operand, string right_operand [,int scale]);</insert>

757

<dialog title="Insert bccomp">bccomp(%0, %1, %2);</dialog>

758

759

</function>

760

761

<description>Divide two arbitrary precision numbers</description>

762

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

763

<param name="right_operand" required="1" vallist="0" default="" type="string">right_operand</param>

764

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

765

<return type="string">string</return>

766

<insert>bcdiv(string left_operand, string right_operand [,int scale]);</insert>

767

<dialog title="Insert bcdiv">bcdiv(%0, %1, %2);</dialog>

768

769

</function>

770

771

772

Get modulus of an arbitrary precision number

773

</description>

774

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

775

<param name="modulus" required="1" vallist="0" default="" type="string">modulus</param>

776

<return type="string">string</return>

777

<insert>bcmod(string left_operand, string modulus);</insert>

778

<dialog title="Insert bcmod">bcmod(%0, %1);</dialog>

779

780

</function>

781

782

<description>Multiply two arbitrary precision number</description>

783

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

784

<param name="right_operand" required="1" vallist="0" default="" type="string">right_operand</param>

785

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

786

<return type="string">string</return>

787

<insert>bcmul(string left_operand, string right_operand [,int scale]);</insert>

788

<dialog title="Insert bcmul">bcmul(%0, %1, %2);</dialog>

789

790

</function>

791

792

793

Raise an arbitrary precision number to another

794

</description>

795

796

797

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

798

<return type="string">string</return>

799

<insert>bcpow(string x, string y [,int scale]);</insert>

800

<dialog title="Insert bcpow">bcpow(%0, %1, %2);</dialog>

801

802

</function>

803

804

805

Raise an arbitrary precision number to another, reduced by a specified modulus.

806

</description>

807

808

809

<param name="modulus" required="1" vallist="0" default="" type="string">modulus</param>

810

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

811

<return type="string">string</return>

812

<insert>bcpowmod(string x, string y, string modulus [,int scale]);</insert>

813

<dialog title="Insert bcpowmod">bcpowmod(%0, %1, %2, %3);</dialog>

814

815

</function>

816

817

818

Set default scale parameter for all bc math functions

819

</description>

820

<param name="scale" required="1" vallist="0" default="" type="int">scale</param>

821

<return type="string">string</return>

822

<insert>bcscale(int scale);</insert>

823

<dialog title="Insert bcscale">bcscale(%0);</dialog>

824

825

</function>

826

827

828

Get the square root of an arbitrary precision number

829

</description>

830

<param name="operand" required="1" vallist="0" default="" type="string">operand</param>

831

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

832

<return type="string">string</return>

833

<insert>bcsqrt(string operand [,int scale]);</insert>

834

<dialog title="Insert bcsqrt">bcsqrt(%0, %1);</dialog>

835

836

</function>

837

838

839

Subtract one arbitrary precision number from another

840

</description>

841

<param name="left_operand" required="1" vallist="0" default="" type="string">left_operand</param>

842

<param name="right_operand" required="1" vallist="0" default="" type="string">right_operand</param>

843

<param name="scale" required="0" vallist="0" default="" type="int">scale</param>

844

<return type="string">string</return>

845

<insert>bcsub(string left_operand, string right_operand [,int scale]);</insert>

846

<dialog title="Insert bcsub">bcsub(%0, %1, %2);</dialog>

847

848

</function>

849

</group>

850

851

852

<description>Close a bzip2 file pointer</description>

853

854

855

<insert>bzclose(resource bz);</insert>

856

<dialog title="Insert bzclose">bzclose(%0);</dialog>

857

858

</function>

859

860

<description>Compress a string into bzip2 encoded data</description>

861

<param name="source" required="1" vallist="0" default="" type="string">source</param>

862

<param name="blocksize" required="0" vallist="0" default="" type="int">blocksize</param>

863

<param name="workfactor" required="0" vallist="0" default="" type="int">workfactor</param>

864

<return type="string">string</return>

865

<insert>bzcompress(string source [,int blocksize] [,int workfactor]);</insert>

866

<dialog title="Insert bzcompress">bzcompress(%0, %1, %2);</dialog>

867

868

</function>

869

870

<description>Decompresses bzip2 encoded data</description>

871

<param name="source" required="1" vallist="0" default="" type="string">source</param>

872

<param name="small" required="0" vallist="0" default="" type="int">small</param>

873

<return type="string">string</return>

874

<insert>bzdecompress(string source [,int small]);</insert>

875

<dialog title="Insert bzdecompress">bzdecompress(%0, %1);</dialog>

876

877

</function>

878

879

<description>Returns a bzip2 error number</description>

880

881

882

<insert>bzerrno(resource bz);</insert>

883

<dialog title="Insert bzerrno">bzerrno(%0);</dialog>

884

885

</function>

886

887

<description>Returns the bzip2 error number and error string in an array</description>

888

889

<return type="array">array</return>

890

<insert>bzerror(resource bz);</insert>

891

<dialog title="Insert bzerror">bzerror(%0);</dialog>

892

893

</function>

894

895

<description>Returns a bzip2 error string</description>

896

897

<return type="string">string</return>

898

<insert>bzerrstr(resource bz);</insert>

899

<dialog title="Insert bzerrstr">bzerrstr(%0);</dialog>

900

901

</function>

902

903

<description>Force a write of all buffered data</description>

904

905

906

<insert>bzflush(resource bz);</insert>

907

<dialog title="Insert bzflush">bzflush(%0);</dialog>

908

909

</function>

910

911

<description>Open a bzip2 compressed file</description>

912

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

913

914

<return type="resource">resource</return>

915

<insert>bzopen(string filename, string mode);</insert>

916

<dialog title="Insert bzopen">bzopen(%0, %1);</dialog>

917

918

</function>

919

920

<description>Binary safe bzip2 file read</description>

921

922

<param name="length" required="0" vallist="0" default="" type="int">length</param>

923

<return type="string">string</return>

924

<insert>bzread(resource bz [,int length]);</insert>

925

<dialog title="Insert bzread">bzread(%0, %1);</dialog>

926

927

</function>

928

929

<description>Binary safe bzip2 file write</description>

930

931

932

<param name="length" required="0" vallist="0" default="" type="int">length</param>

933

934

<insert>bzwrite(resource bz, string data [,int length]);</insert>

935

<dialog title="Insert bzwrite">bzwrite(%0, %1, %2);</dialog>

936

937

</function>

938

</group>

939

940

941

<description>Return the number of days in a month for a given year and calendar</description>

942

<param name="calendar" required="1" vallist="0" default="" type="int">calendar</param>

943

<param name="month" required="1" vallist="0" default="" type="int">month</param>

944

945

946

<insert>cal_days_in_month(int calendar, int month, int year);</insert>

947

<dialog title="Insert cal_days_in_month">cal_days_in_month(%0, %1, %2);</dialog>

948

949

</function>

950

951

<description>Converts from Julian Day Count to a supported calendar</description>

952

953

<param name="calendar" required="1" vallist="0" default="" type="int">calendar</param>

954

<return type="array">array</return>

955

<insert>cal_from_jd(int jd, int calendar);</insert>

956

957

958

</function>

959

960

<description>Returns information about a particular calendar</description>

961

<param name="calendar" required="0" vallist="0" default="" type="int">calendar</param>

962

<return type="array">array</return>

963

<insert>cal_info([int calendar]);</insert>

964

965

966

</function>

967

968

<description>Converts from a supported calendar to Julian Day Count</description>

969

<param name="calendar" required="1" vallist="0" default="" type="int">calendar</param>

970

<param name="month" required="1" vallist="0" default="" type="int">month</param>

971

972

973

974

<insert>cal_to_jd(int calendar, int month, int day, int year);</insert>

975

976

977

</function>

978

979

980

Get UNIX timestamp for midnight on Easter of a given year

981

</description>

982

983

984

<insert>easter_date([int year]);</insert>

985

<dialog title="Insert easter_date">easter_date(%0);</dialog>

986

987

</function>

988

989

990

Get number of days after March 21 on which Easter falls for a

991

given year

992

</description>

993

994

<param name="method" required="0" vallist="0" default="" type="int">method</param>

995

996

<insert>easter_days([int year] [,int method]);</insert>

997

<dialog title="Insert easter_days">easter_days(%0, %1);</dialog>

998

999

</function>

1000

1001

1002

Converts a date from the French Republican Calendar to a Julian

1003

Day Count

1004

</description>

1005

<param name="month" required="1" vallist="0" default="" type="int">month</param>

1006

1007

1008

1009

<insert>FrenchToJD(int month, int day, int year);</insert>

1010

<dialog title="Insert FrenchToJD">FrenchToJD(%0, %1, %2);</dialog>

1011

1012

</function>

1013

1014

1015

Converts a Gregorian date to Julian Day Count

1016

</description>

1017

<param name="month" required="1" vallist="0" default="" type="int">month</param>

1018

1019

1020

1021

<insert>GregorianToJD(int month, int day, int year);</insert>

1022

<dialog title="Insert GregorianToJD">GregorianToJD(%0, %1, %2);</dialog>

1023

1024

</function>

1025

1026

<description>Returns the day of the week</description>

1027

<param name="julianday" required="1" vallist="0" default="" type="int">julianday</param>

1028

1029

<return type="mixed">mixed</return>

1030

<insert>JDDayOfWeek(int julianday, int mode);</insert>

1031

<dialog title="Insert JDDayOfWeek">JDDayOfWeek(%0, %1);</dialog>

1032

1033

</function>

1034

1035

<description>Returns a month name</description>

1036

<param name="julianday" required="1" vallist="0" default="" type="int">julianday</param>

1037

1038

<return type="string">string</return>

1039

<insert>JDMonthName(int julianday, int mode);</insert>

1040

<dialog title="Insert JDMonthName">JDMonthName(%0, %1);</dialog>

1041

1042

</function>

1043

1044

1045

Converts a Julian Day Count to the French Republican Calendar

1046

</description>

1047

<param name="juliandaycount" required="1" vallist="0" default="" type="int">juliandaycount</param>

1048

<return type="string">string</return>

1049

<insert>JDToFrench(int juliandaycount);</insert>

1050

<dialog title="Insert JDToFrench">JDToFrench(%0);</dialog>

1051

1052

</function>

1053

1054

<description>Converts Julian Day Count to Gregorian date</description>

1055

<param name="julianday" required="1" vallist="0" default="" type="int">julianday</param>

1056

<return type="string">string</return>

1057

<insert>JDToGregorian(int julianday);</insert>

1058

<dialog title="Insert JDToGregorian">JDToGregorian(%0);</dialog>

1059

1060

</function>

1061

1062

1063

Converts a Julian Day Count to the Jewish Calendar

1064

</description>

1065

<param name="julianday" required="1" vallist="0" default="" type="int">julianday</param>

1066

<return type="string">string</return>

1067

<insert>JDToJewish(int julianday);</insert>

1068

<dialog title="Insert JDToJewish">JDToJewish(%0);</dialog>

1069

1070

</function>

1071

1072

1073

Converts a Julian Day Count to a Julian Calendar Date

1074

</description>

1075

<param name="julianday" required="1" vallist="0" default="" type="int">julianday</param>

1076

<return type="string">string</return>

1077

<insert>JDToJulian(int julianday);</insert>

1078

<dialog title="Insert JDToJulian">JDToJulian(%0);</dialog>

1079

1080

</function>

1081

1082

<description>Convert Julian Day to UNIX timestamp</description>

1083

1084

1085

<insert>jdtounix(int jday);</insert>

1086

<dialog title="Insert jdtounix">jdtounix(%0);</dialog>

1087

1088

</function>

1089

1090

1091

Converts a date in the Jewish Calendar to Julian Day Count

1092

</description>

1093

<param name="month" required="1" vallist="0" default="" type="int">month</param>

1094

1095

1096

1097

<insert>JewishToJD(int month, int day, int year);</insert>

1098

<dialog title="Insert JewishToJD">JewishToJD(%0, %1, %2);</dialog>

1099

1100

</function>

1101

1102

1103

Converts a Julian Calendar date to Julian Day Count

1104

</description>

1105

<param name="month" required="1" vallist="0" default="" type="int">month</param>

1106

1107

1108

1109

<insert>JulianToJD(int month, int day, int year);</insert>

1110

<dialog title="Insert JulianToJD">JulianToJD(%0, %1, %2);</dialog>

1111

1112

</function>

1113

1114

<description>Convert UNIX timestamp to Julian Day</description>

1115

<param name="timestamp" required="0" vallist="0" default="" type="int">timestamp</param>

1116

1117

<insert>unixtojd([int timestamp]);</insert>

1118

<dialog title="Insert unixtojd">unixtojd(%0);</dialog>

1119

1120

</function>

1121

</group>

1122

1123

1124

<description>Add data to a transaction </description>

1125

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1126

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1127

<param name="argtype" required="1" vallist="0" default="" type="string">argtype</param>

1128

<param name="argval" required="1" vallist="0" default="" type="string">argval</param>

1129

<return type="string">string</return>

1130

<insert>ccvs_add(string session, string invoice, string argtype, string argval);</insert>

1131

1132

1133

</function>

1134

1135

1136

Perform credit authorization test on a transaction

1137

</description>

1138

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1139

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1140

<return type="string">string</return>

1141

<insert>ccvs_auth(string session, string invoice);</insert>

1142

1143

1144

</function>

1145

1146

1147

Performs a command which is peculiar to a single protocol,

1148

and thus is not available in the general CCVS API

1149

</description>

1150

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1151

1152

<param name="argval" required="1" vallist="0" default="" type="string">argval</param>

1153

<return type="string">string</return>

1154

<insert>ccvs_command(string session, string type, string argval);</insert>

1155

<dialog title="Insert ccvs_command">ccvs_command(%0, %1, %2);</dialog>

1156

1157

</function>

1158

1159

1160

Find out how many transactions of a given type are stored in the system

1161

</description>

1162

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1163

1164

1165

<insert>ccvs_count(string session, string type);</insert>

1166

<dialog title="Insert ccvs_count">ccvs_count(%0, %1);</dialog>

1167

1168

</function>

1169

1170

<description>Delete a transaction</description>

1171

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1172

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1173

<return type="string">string</return>

1174

<insert>ccvs_delete(string session, string invoice);</insert>

1175

<dialog title="Insert ccvs_delete">ccvs_delete(%0, %1);</dialog>

1176

1177

</function>

1178

1179

<description>Terminate CCVS engine and do cleanup work</description>

1180

1181

<return type="string">string</return>

1182

<insert>ccvs_done(string sess);</insert>

1183

1184

1185

</function>

1186

1187

<description>Initialize CCVS for use</description>

1188

1189

<return type="string">string</return>

1190

<insert>ccvs_init(string name);</insert>

1191

1192

1193

</function>

1194

1195

1196

Look up an item of a particular type in the database #

1197

</description>

1198

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1199

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1200

1201

<return type="string">string</return>

1202

<insert>ccvs_lookup(string session, string invoice, int inum);</insert>

1203

<dialog title="Insert ccvs_lookup">ccvs_lookup(%0, %1, %2);</dialog>

1204

1205

</function>

1206

1207

<description>Create a new, blank transaction </description>

1208

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1209

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1210

<return type="string">string</return>

1211

<insert>ccvs_new(string session, string invoice);</insert>

1212

1213

1214

</function>

1215

1216

<description>Return the status of the background communication process </description>

1217

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1218

1219

<return type="string">string</return>

1220

<insert>ccvs_report(string session, string type);</insert>

1221

<dialog title="Insert ccvs_report">ccvs_report(%0, %1);</dialog>

1222

1223

</function>

1224

1225

1226

Transfer funds from the merchant to the credit card holder

1227

</description>

1228

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1229

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1230

<return type="string">string</return>

1231

<insert>ccvs_return(string session, string invoice);</insert>

1232

<dialog title="Insert ccvs_return">ccvs_return(%0, %1);</dialog>

1233

1234

</function>

1235

1236

1237

Perform a full reversal on an already-processed authorization

1238

</description>

1239

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1240

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1241

<return type="string">string</return>

1242

<insert>ccvs_reverse(string session, string invoice);</insert>

1243

<dialog title="Insert ccvs_reverse">ccvs_reverse(%0, %1);</dialog>

1244

1245

</function>

1246

1247

1248

Transfer funds from the credit card holder to the merchant

1249

</description>

1250

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1251

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1252

<return type="string">string</return>

1253

<insert>ccvs_sale(string session, string invoice);</insert>

1254

1255

1256

</function>

1257

1258

<description>Check the status of an invoice</description>

1259

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1260

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1261

<return type="string">string</return>

1262

<insert>ccvs_status(string session, string invoice);</insert>

1263

<dialog title="Insert ccvs_status">ccvs_status(%0, %1);</dialog>

1264

1265

</function>

1266

1267

<description>Get text return value for previous function call</description>

1268

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1269

<return type="string">string</return>

1270

<insert>ccvs_textvalue(string session);</insert>

1271

<dialog title="Insert ccvs_textvalue">ccvs_textvalue(%0);</dialog>

1272

1273

</function>

1274

1275

1276

Perform a full reversal on a completed transaction

1277

</description>

1278

<param name="session" required="1" vallist="0" default="" type="string">session</param>

1279

<param name="invoice" required="1" vallist="0" default="" type="string">invoice</param>

1280

<return type="string">string</return>

1281

<insert>ccvs_void(string session, string invoice);</insert>

1282

1283

1284

</function>

1285

</group>

1286

1287

1288

1289

Call a user method given with an array of parameters [deprecated]

1290

</description>

1291

<param name="method_name" required="1" vallist="0" default="" type="string">method_name</param>

1292

1293

<param name="paramarr" required="0" vallist="0" default="" type="array">paramarr</param>

1294

<return type="mixed">mixed</return>

1295

<insert>call_user_method_array(string method_name, object obj [,array paramarr]);</insert>

1296

<dialog title="Insert call_user_method_array">call_user_method_array(%0, %1, %2);</dialog>

1297

1298

</function>

1299

1300

1301

Call a user method on an specific object [deprecated]

1302

</description>

1303

<param name="method_name" required="1" vallist="0" default="" type="string">method_name</param>

1304

1305

<param name="parameter" required="0" vallist="0" default="" type="mixed">parameter</param>

1306

1307

<return type="mixed">mixed</return>

1308

<insert>call_user_method(string method_name, object obj [,mixed parameter] [,mixed ...]);</insert>

1309

<dialog title="Insert call_user_method">call_user_method(%0, %1, %2, %3);</dialog>

1310

1311

</function>

1312

1313

<description>Checks if the class has been defined</description>

1314

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

1315

1316

<insert>class_exists(string class_name);</insert>

1317

<dialog title="Insert class_exists">class_exists(%0);</dialog>

1318

1319

</function>

1320

1321

<description>Returns an array of class methods' names</description>

1322

<param name="class_name" required="1" vallist="0" default="" type="mixed">class_name</param>

1323

<return type="array">array</return>

1324

<insert>get_class_methods(mixed class_name);</insert>

1325

<dialog title="Insert get_class_methods">get_class_methods(%0);</dialog>

1326

1327

</function>

1328

1329

1330

Returns an array of default properties of the class

1331

</description>

1332

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

1333

<return type="array">array</return>

1334

<insert>get_class_vars(string class_name);</insert>

1335

<dialog title="Insert get_class_vars">get_class_vars(%0);</dialog>

1336

1337

</function>

1338

1339

<description>Returns the name of the class of an object</description>

1340

1341

<return type="string">string</return>

1342

<insert>get_class(object obj);</insert>

1343

<dialog title="Insert get_class">get_class(%0);</dialog>

1344

1345

</function>

1346

1347

<description>Returns an array with the name of the defined classes</description>

1348

<return type="array">array</return>

1349

<insert>get_declared_classes();</insert>

1350

<dialog title="Insert get_declared_classes">get_declared_classes();</dialog>

1351

1352

</function>

1353

1354

<description>Returns an associative array of object properties</description>

1355

1356

<return type="array">array</return>

1357

<insert>get_object_vars(object obj);</insert>

1358

<dialog title="Insert get_object_vars">get_object_vars(%0);</dialog>

1359

1360

</function>

1361

1362

<description>Retrieves the parent class name for object or class</description>

1363

1364

<return type="string">string</return>

1365

<insert>get_parent_class(mixed obj);</insert>

1366

<dialog title="Insert get_parent_class">get_parent_class(%0);</dialog>

1367

1368

</function>

1369

1370

1371

Returns </description>

1372

<param name="object" required="1" vallist="0" default="" type="object">object</param>

1373

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

1374

1375

<insert>is_a(object object, string class_name);</insert>

1376

1377

1378

</function>

1379

1380

1381

Returns </description>

1382

<param name="object" required="1" vallist="0" default="" type="object">object</param>

1383

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

1384

1385

<insert>is_subclass_of(object object, string class_name);</insert>

1386

<dialog title="Insert is_subclass_of">is_subclass_of(%0, %1);</dialog>

1387

1388

</function>

1389

1390

<description>Checks if the class method exists</description>

1391

<param name="object" required="1" vallist="0" default="" type="object">object</param>

1392

<param name="method_name" required="1" vallist="0" default="" type="string">method_name</param>

1393

1394

<insert>method_exists(object object, string method_name);</insert>

1395

<dialog title="Insert method_exists">method_exists(%0, %1);</dialog>

1396

1397

</function>

1398

</group>

1399

1400

1401

<description>COM class</description>

1402

<param name="module_name" required="1" vallist="0" default="" type="string">module_name</param>

1403

<param name="server_name" required="0" vallist="0" default="" type="string">server_name</param>

1404

<param name="codepage" required="0" vallist="0" default="" type="int">codepage</param>

1405

<return type="string">string</return>

1406

<insert>COM(string module_name [,string server_name] [,int codepage]);</insert>

1407

1408

1409

</function>

1410

1411

<description>VARIANT class</description>

1412

<param name="value" required="0" vallist="0" default="" type="mixed">value</param>

1413

1414

<param name="codepage" required="0" vallist="0" default="" type="int">codepage</param>

1415

<return type="string">string</return>

1416

<insert>VARIANT([mixed value] [,int type] [,int codepage]);</insert>

1417

<dialog title="Insert VARIANT">VARIANT(%0, %1, %2);</dialog>

1418

1419

</function>

1420

1421

1422

Increases the components reference counter.

1423

</description>

1424

1425

<insert>com_addref();</insert>

1426

<dialog title="Insert com_addref">com_addref();</dialog>

1427

1428

</function>

1429

1430

1431

Gets the value of a COM Component's property

1432

</description>

1433

<param name="com_object" required="1" vallist="0" default="" type="resource">com_object</param>

1434

<param name="property" required="1" vallist="0" default="" type="string">property</param>

1435

<return type="mixed">mixed</return>

1436

<insert>com_get(resource com_object, string property);</insert>

1437

1438

1439

</function>

1440

1441

1442

Calls a COM component's method.

1443

</description>

1444

<param name="com_object" required="1" vallist="0" default="" type="resource">com_object</param>

1445

<param name="function_name" required="1" vallist="0" default="" type="string">function_name</param>

1446

<param name="

1447

function parameters, ...

1448

" required="0" vallist="0" default="" type="mixed">

1449

function parameters, ...

1450

</param>

1451

<return type="mixed">mixed</return>

1452

<insert>com_invoke(resource com_object, string function_name [,mixed

1453

function parameters, ...

1454

]);</insert>

1455

<dialog title="Insert com_invoke">com_invoke(%0, %1, %2);</dialog>

1456

1457

</function>

1458

1459

<description>Grabs an IEnumVariant</description>

1460

<param name="com_module" required="1" vallist="0" default="" type="object">com_module</param>

1461

1462

<insert>com_isenum(object com_module);</insert>

1463

<dialog title="Insert com_isenum">com_isenum(%0);</dialog>

1464

1465

</function>

1466

1467

<description>Loads a Typelib</description>

1468

<param name="typelib_name" required="1" vallist="0" default="" type="string">typelib_name</param>

1469

<param name="case_insensitive" required="0" vallist="0" default="" type="int">case_insensitive</param>

1470

1471

<insert>com_load_typelib(string typelib_name [,int case_insensitive]);</insert>

1472

<dialog title="Insert com_load_typelib">com_load_typelib(%0, %1);</dialog>

1473

1474

</function>

1475

1476

1477

Creates a new reference to a COM component

1478

</description>

1479

<param name="module_name" required="1" vallist="0" default="" type="string">module_name</param>

1480

<param name="

1481

server_name

1482

" required="0" vallist="0" default="" type="string">

1483

server_name

1484

</param>

1485

<param name="

1486

codepage

1487

" required="0" vallist="0" default="" type="int">

1488

codepage

1489

</param>

1490

<return type="string">string</return>

1491

<insert>com_load(string module_name [,string

1492

server_name

1493

] [,int

1494

codepage

1495

]);</insert>

1496

1497

1498

</function>

1499

1500

1501

Decreases the components reference counter.

1502

</description>

1503

1504

<insert>com_release();</insert>

1505

<dialog title="Insert com_release">com_release();</dialog>

1506

1507

</function>

1508

1509

1510

Assigns a value to a COM component's property

1511

</description>

1512

<param name="com_object" required="1" vallist="0" default="" type="resource">com_object</param>

1513

<param name="property" required="1" vallist="0" default="" type="string">property</param>

1514

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

1515

1516

<insert>com_set(resource com_object, string property, mixed value);</insert>

1517

1518

1519

</function>

1520

</group>

1521

1522

1523

<description>Adds annotation</description>

1524

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1525

1526

1527

1528

1529

<param name="title" required="1" vallist="0" default="" type="string">title</param>

1530

<param name="content" required="1" vallist="0" default="" type="string">content</param>

1531

1532

1533

<insert>cpdf_add_annotation(int pdf_document, float llx, float lly, float urx, float ury, string title, string content [,int mode]);</insert>

1534

<dialog title="Insert cpdf_add_annotation">cpdf_add_annotation(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

1535

1536

</function>

1537

1538

<description>Adds bookmark for current page</description>

1539

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1540

1541

1542

<insert>cpdf_add_outline(int pdf_document, string text);</insert>

1543

<dialog title="Insert cpdf_add_outline">cpdf_add_outline(%0, %1);</dialog>

1544

1545

</function>

1546

1547

<description>Draws an arc</description>

1548

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1549

1550

1551

<param name="radius" required="1" vallist="0" default="" type="float">radius</param>

1552

<param name="start" required="1" vallist="0" default="" type="float">start</param>

1553

1554

1555

1556

<insert>cpdf_arc(int pdf_document, float x-coor, float y-coor, float radius, float start, float end [,int mode]);</insert>

1557

1558

1559

</function>

1560

1561

<description>Starts text section</description>

1562

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1563

1564

<insert>cpdf_begin_text(int pdf_document);</insert>

1565

<dialog title="Insert cpdf_begin_text">cpdf_begin_text(%0);</dialog>

1566

1567

</function>

1568

1569

<description>Draw a circle</description>

1570

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1571

1572

1573

<param name="radius" required="1" vallist="0" default="" type="float">radius</param>

1574

1575

1576

<insert>cpdf_circle(int pdf_document, float x-coor, float y-coor, float radius [,int mode]);</insert>

1577

<dialog title="Insert cpdf_circle">cpdf_circle(%0, %1, %2, %3, %4);</dialog>

1578

1579

</function>

1580

1581

<description>Clips to current path</description>

1582

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1583

1584

<insert>cpdf_clip(int pdf_document);</insert>

1585

1586

1587

</function>

1588

1589

<description>Closes the pdf document</description>

1590

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1591

1592

<insert>cpdf_close(int pdf_document);</insert>

1593

<dialog title="Insert cpdf_close">cpdf_close(%0);</dialog>

1594

1595

</function>

1596

1597

<description>Close, fill and stroke current path</description>

1598

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1599

1600

<insert>cpdf_closepath_fill_stroke(int pdf_document);</insert>

1601

<dialog title="Insert cpdf_closepath_fill_stroke">cpdf_closepath_fill_stroke(%0);</dialog>

1602

1603

</function>

1604

1605

<description>Close path and draw line along path</description>

1606

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1607

1608

<insert>cpdf_closepath_stroke(int pdf_document);</insert>

1609

<dialog title="Insert cpdf_closepath_stroke">cpdf_closepath_stroke(%0);</dialog>

1610

1611

</function>

1612

1613

<description>Close path</description>

1614

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1615

1616

<insert>cpdf_closepath(int pdf_document);</insert>

1617

<dialog title="Insert cpdf_closepath">cpdf_closepath(%0);</dialog>

1618

1619

</function>

1620

1621

<description>Output text in next line</description>

1622

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1623

1624

1625

<insert>cpdf_continue_text(int pdf_document, string text);</insert>

1626

<dialog title="Insert cpdf_continue_text">cpdf_continue_text(%0, %1);</dialog>

1627

1628

</function>

1629

1630

<description>Draws a curve</description>

1631

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1632

1633

1634

1635

1636

1637

1638

1639

1640

<insert>cpdf_curveto(int pdf_document, float x1, float y1, float x2, float y2, float x3, float y3 [,int mode]);</insert>

1641

<dialog title="Insert cpdf_curveto">cpdf_curveto(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

1642

1643

</function>

1644

1645

<description>Ends text section</description>

1646

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1647

1648

<insert>cpdf_end_text(int pdf_document);</insert>

1649

1650

1651

</function>

1652

1653

<description>Fill and stroke current path</description>

1654

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1655

1656

<insert>cpdf_fill_stroke(int pdf_document);</insert>

1657

<dialog title="Insert cpdf_fill_stroke">cpdf_fill_stroke(%0);</dialog>

1658

1659

</function>

1660

1661

<description>Fill current path</description>

1662

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1663

1664

<insert>cpdf_fill(int pdf_document);</insert>

1665

1666

1667

</function>

1668

1669

1670

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1671

<param name="page_number" required="1" vallist="0" default="" type="int">page_number</param>

1672

1673

<insert>cpdf_finalize_page(int pdf_document, int page_number);</insert>

1674

<dialog title="Insert cpdf_finalize_page">cpdf_finalize_page(%0, %1);</dialog>

1675

1676

</function>

1677

1678

<description>Ends document</description>

1679

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1680

1681

<insert>cpdf_finalize(int pdf_document);</insert>

1682

<dialog title="Insert cpdf_finalize">cpdf_finalize(%0);</dialog>

1683

1684

</function>

1685

1686

<description>Sets document limits for any pdf document</description>

1687

<param name="maxpages" required="1" vallist="0" default="" type="int">maxpages</param>

1688

<param name="maxfonts" required="1" vallist="0" default="" type="int">maxfonts</param>

1689

<param name="maximages" required="1" vallist="0" default="" type="int">maximages</param>

1690

<param name="maxannotations" required="1" vallist="0" default="" type="int">maxannotations</param>

1691

<param name="maxobjects" required="1" vallist="0" default="" type="int">maxobjects</param>

1692

1693

<insert>cpdf_global_set_document_limits(int maxpages, int maxfonts, int maximages, int maxannotations, int maxobjects);</insert>

1694

<dialog title="Insert cpdf_global_set_document_limits">cpdf_global_set_document_limits(%0, %1, %2, %3, %4);</dialog>

1695

1696

</function>

1697

1698

<description>Opens a JPEG image</description>

1699

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1700

1701

1702

1703

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

1704

<param name="width" required="1" vallist="0" default="" type="float">width</param>

1705

<param name="height" required="1" vallist="0" default="" type="float">height</param>

1706

<param name="x-scale" required="1" vallist="0" default="" type="float">x-scale</param>

1707

<param name="y-scale" required="1" vallist="0" default="" type="float">y-scale</param>

1708

1709

1710

<insert>cpdf_import_jpeg(int pdf_document, string file name, float x-coor, float y-coor, float angle, float width, float height, float x-scale, float y-scale [,int mode]);</insert>

1711

<dialog title="Insert cpdf_import_jpeg">cpdf_import_jpeg(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9);</dialog>

1712

1713

</function>

1714

1715

<description>Draws a line</description>

1716

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1717

1718

1719

1720

1721

<insert>cpdf_lineto(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

1722

<dialog title="Insert cpdf_lineto">cpdf_lineto(%0, %1, %2, %3);</dialog>

1723

1724

</function>

1725

1726

<description>Sets current point</description>

1727

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1728

1729

1730

1731

1732

<insert>cpdf_moveto(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

1733

<dialog title="Insert cpdf_moveto">cpdf_moveto(%0, %1, %2, %3);</dialog>

1734

1735

</function>

1736

1737

<description>Starts a new path</description>

1738

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1739

1740

<insert>cpdf_newpath(int pdf_document);</insert>

1741

<dialog title="Insert cpdf_newpath">cpdf_newpath(%0);</dialog>

1742

1743

</function>

1744

1745

<description>Opens a new pdf document</description>

1746

<param name="compression" required="1" vallist="0" default="" type="int">compression</param>

1747

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

1748

1749

<insert>cpdf_open(int compression [,string filename]);</insert>

1750

1751

1752

</function>

1753

1754

<description>Outputs the pdf document in memory buffer</description>

1755

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1756

1757

<insert>cpdf_output_buffer(int pdf_document);</insert>

1758

<dialog title="Insert cpdf_output_buffer">cpdf_output_buffer(%0);</dialog>

1759

1760

</function>

1761

1762

<description>Starts new page</description>

1763

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1764

<param name="page_number" required="1" vallist="0" default="" type="int">page_number</param>

1765

<param name="orientation" required="1" vallist="0" default="" type="int">orientation</param>

1766

<param name="height" required="1" vallist="0" default="" type="float">height</param>

1767

<param name="width" required="1" vallist="0" default="" type="float">width</param>

1768

1769

1770

<insert>cpdf_page_init(int pdf_document, int page_number, int orientation, float height, float width [,float unit]);</insert>

1771

1772

1773

</function>

1774

1775

<description>Places an image on the page</description>

1776

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1777

<param name="image" required="1" vallist="0" default="" type="int">image</param>

1778

1779

1780

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

1781

<param name="width" required="1" vallist="0" default="" type="float">width</param>

1782

<param name="height" required="1" vallist="0" default="" type="float">height</param>

1783

1784

1785

<insert>cpdf_place_inline_image(int pdf_document, int image, float x-coor, float y-coor, float angle, float width, float height [,int mode]);</insert>

1786

<dialog title="Insert cpdf_place_inline_image">cpdf_place_inline_image(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

1787

1788

</function>

1789

1790

<description>Draw a rectangle</description>

1791

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1792

1793

1794

<param name="width" required="1" vallist="0" default="" type="float">width</param>

1795

<param name="height" required="1" vallist="0" default="" type="float">height</param>

1796

1797

1798

<insert>cpdf_rect(int pdf_document, float x-coor, float y-coor, float width, float height [,int mode]);</insert>

1799

1800

1801

</function>

1802

1803

<description>Restores formerly saved environment</description>

1804

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1805

1806

<insert>cpdf_restore(int pdf_document);</insert>

1807

<dialog title="Insert cpdf_restore">cpdf_restore(%0);</dialog>

1808

1809

</function>

1810

1811

<description>Draws a line</description>

1812

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1813

1814

1815

1816

1817

<insert>cpdf_rlineto(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

1818

<dialog title="Insert cpdf_rlineto">cpdf_rlineto(%0, %1, %2, %3);</dialog>

1819

1820

</function>

1821

1822

<description>Sets current point</description>

1823

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1824

1825

1826

1827

1828

<insert>cpdf_rmoveto(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

1829

<dialog title="Insert cpdf_rmoveto">cpdf_rmoveto(%0, %1, %2, %3);</dialog>

1830

1831

</function>

1832

1833

1834

Sets text rotation angle

1835

</description>

1836

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

1837

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

1838

1839

<insert>cpdf_rotate_text(int pdfdoc, float angle);</insert>

1840

<dialog title="Insert cpdf_rotate_text">cpdf_rotate_text(%0, %1);</dialog>

1841

1842

</function>

1843

1844

<description>Sets rotation</description>

1845

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1846

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

1847

1848

<insert>cpdf_rotate(int pdf_document, float angle);</insert>

1849

<dialog title="Insert cpdf_rotate">cpdf_rotate(%0, %1);</dialog>

1850

1851

</function>

1852

1853

<description>Writes the pdf document into a file</description>

1854

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1855

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

1856

1857

<insert>cpdf_save_to_file(int pdf_document, string filename);</insert>

1858

1859

1860

</function>

1861

1862

<description>Saves current environment</description>

1863

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1864

1865

<insert>cpdf_save(int pdf_document);</insert>

1866

1867

1868

</function>

1869

1870

<description>Sets scaling</description>

1871

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1872

<param name="x-scale" required="1" vallist="0" default="" type="float">x-scale</param>

1873

<param name="y-scale" required="1" vallist="0" default="" type="float">y-scale</param>

1874

1875

<insert>cpdf_scale(int pdf_document, float x-scale, float y-scale);</insert>

1876

<dialog title="Insert cpdf_scale">cpdf_scale(%0, %1, %2);</dialog>

1877

1878

</function>

1879

1880

1881

Sets hyperlink

1882

</description>

1883

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

1884

1885

1886

1887

1888

1889

1890

1891

<insert>cpdf_set_action_url(int pdfdoc, float xll, float yll, float xur, float xur, string url [,int mode]);</insert>

1892

<dialog title="Insert cpdf_set_action_url">cpdf_set_action_url(%0, %1, %2, %3, %4, %5, %6);</dialog>

1893

1894

</function>

1895

1896

<description>Sets character spacing</description>

1897

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1898

<param name="space" required="1" vallist="0" default="" type="float">space</param>

1899

1900

<insert>cpdf_set_char_spacing(int pdf_document, float space);</insert>

1901

<dialog title="Insert cpdf_set_char_spacing">cpdf_set_char_spacing(%0, %1);</dialog>

1902

1903

</function>

1904

1905

<description>Sets the creator field in the pdf document</description>

1906

<param name="creator" required="1" vallist="0" default="" type="string">creator</param>

1907

1908

<insert>cpdf_set_creator(string creator);</insert>

1909

<dialog title="Insert cpdf_set_creator">cpdf_set_creator(%0);</dialog>

1910

1911

</function>

1912

1913

<description>Sets current page</description>

1914

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1915

<param name="page_number" required="1" vallist="0" default="" type="int">page_number</param>

1916

1917

<insert>cpdf_set_current_page(int pdf_document, int page_number);</insert>

1918

<dialog title="Insert cpdf_set_current_page">cpdf_set_current_page(%0, %1);</dialog>

1919

1920

</function>

1921

1922

1923

Sets directories to search when using external fonts

1924

</description>

1925

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

1926

<param name="pfmdir" required="1" vallist="0" default="" type="string">pfmdir</param>

1927

<param name="pfbdir" required="1" vallist="0" default="" type="string">pfbdir</param>

1928

1929

<insert>cpdf_set_font_directories(int pdfdoc, string pfmdir, string pfbdir);</insert>

1930

<dialog title="Insert cpdf_set_font_directories">cpdf_set_font_directories(%0, %1, %2);</dialog>

1931

1932

</function>

1933

1934

1935

Sets fontname to filename translation map when using external fonts

1936

</description>

1937

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

1938

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

1939

1940

<insert>cpdf_set_font_map_file(int pdfdoc, string filename);</insert>

1941

1942

1943

</function>

1944

1945

<description>Select the current font face and size</description>

1946

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1947

1948

1949

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

1950

1951

<insert>cpdf_set_font(int pdf_document, string font name, float size, string encoding);</insert>

1952

1953

1954

</function>

1955

1956

<description>Sets horizontal scaling of text</description>

1957

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1958

<param name="scale" required="1" vallist="0" default="" type="float">scale</param>

1959

1960

<insert>cpdf_set_horiz_scaling(int pdf_document, float scale);</insert>

1961

<dialog title="Insert cpdf_set_horiz_scaling">cpdf_set_horiz_scaling(%0, %1);</dialog>

1962

1963

</function>

1964

1965

<description>Sets the keywords field of the pdf document</description>

1966

<param name="keywords" required="1" vallist="0" default="" type="string">keywords</param>

1967

1968

<insert>cpdf_set_keywords(string keywords);</insert>

1969

<dialog title="Insert cpdf_set_keywords">cpdf_set_keywords(%0);</dialog>

1970

1971

</function>

1972

1973

<description>Sets distance between text lines</description>

1974

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1975

<param name="distance" required="1" vallist="0" default="" type="float">distance</param>

1976

1977

<insert>cpdf_set_leading(int pdf_document, float distance);</insert>

1978

<dialog title="Insert cpdf_set_leading">cpdf_set_leading(%0, %1);</dialog>

1979

1980

</function>

1981

1982

<description>Sets duration between pages</description>

1983

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

1984

<param name="transition" required="1" vallist="0" default="" type="int">transition</param>

1985

<param name="duration" required="1" vallist="0" default="" type="float">duration</param>

1986

1987

<insert>cpdf_set_page_animation(int pdf_document, int transition, float duration);</insert>

1988

<dialog title="Insert cpdf_set_page_animation">cpdf_set_page_animation(%0, %1, %2);</dialog>

1989

1990

</function>

1991

1992

<description>Sets the subject field of the pdf document</description>

1993

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

1994

1995

<insert>cpdf_set_subject(string subject);</insert>

1996

<dialog title="Insert cpdf_set_subject">cpdf_set_subject(%0);</dialog>

1997

1998

</function>

1999

2000

<description>Sets the text matrix</description>

2001

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2002

<param name="matrix" required="1" vallist="0" default="" type="array">matrix</param>

2003

2004

<insert>cpdf_set_text_matrix(int pdf_document, array matrix);</insert>

2005

<dialog title="Insert cpdf_set_text_matrix">cpdf_set_text_matrix(%0, %1);</dialog>

2006

2007

</function>

2008

2009

<description>Sets text position</description>

2010

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2011

2012

2013

2014

2015

<insert>cpdf_set_text_pos(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

2016

2017

2018

</function>

2019

2020

<description>Determines how text is rendered</description>

2021

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2022

2023

2024

<insert>cpdf_set_text_rendering(int pdf_document [,int mode]);</insert>

2025

<dialog title="Insert cpdf_set_text_rendering">cpdf_set_text_rendering(%0, %1);</dialog>

2026

2027

</function>

2028

2029

2030

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2031

<param name="value" required="1" vallist="0" default="" type="float">value</param>

2032

2033

<insert>cpdf_set_text_rise(int pdf_document, float value);</insert>

2034

2035

2036

</function>

2037

2038

<description>Sets the title field of the pdf document</description>

2039

<param name="title" required="1" vallist="0" default="" type="string">title</param>

2040

2041

<insert>cpdf_set_title(string title);</insert>

2042

<dialog title="Insert cpdf_set_title">cpdf_set_title(%0);</dialog>

2043

2044

</function>

2045

2046

2047

How to show the document in the viewer

2048

</description>

2049

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

2050

<param name="preferences" required="1" vallist="0" default="" type="array">preferences</param>

2051

2052

<insert>cpdf_set_viewer_preferences(int pdfdoc, array preferences);</insert>

2053

<dialog title="Insert cpdf_set_viewer_preferences">cpdf_set_viewer_preferences(%0, %1);</dialog>

2054

2055

</function>

2056

2057

<description>Sets spacing between words</description>

2058

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2059

<param name="space" required="1" vallist="0" default="" type="float">space</param>

2060

2061

<insert>cpdf_set_word_spacing(int pdf_document, float space);</insert>

2062

<dialog title="Insert cpdf_set_word_spacing">cpdf_set_word_spacing(%0, %1);</dialog>

2063

2064

</function>

2065

2066

<description>Sets dash pattern</description>

2067

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2068

<param name="white" required="1" vallist="0" default="" type="float">white</param>

2069

<param name="black" required="1" vallist="0" default="" type="float">black</param>

2070

2071

<insert>cpdf_setdash(int pdf_document, float white, float black);</insert>

2072

<dialog title="Insert cpdf_setdash">cpdf_setdash(%0, %1, %2);</dialog>

2073

2074

</function>

2075

2076

<description>Sets flatness</description>

2077

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2078

<param name="value" required="1" vallist="0" default="" type="float">value</param>

2079

2080

<insert>cpdf_setflat(int pdf_document, float value);</insert>

2081

<dialog title="Insert cpdf_setflat">cpdf_setflat(%0, %1);</dialog>

2082

2083

</function>

2084

2085

<description>Sets filling color to gray value</description>

2086

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2087

<param name="value" required="1" vallist="0" default="" type="float">value</param>

2088

2089

<insert>cpdf_setgray_fill(int pdf_document, float value);</insert>

2090

<dialog title="Insert cpdf_setgray_fill">cpdf_setgray_fill(%0, %1);</dialog>

2091

2092

</function>

2093

2094

<description>Sets drawing color to gray value</description>

2095

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2096

<param name="gray_value" required="1" vallist="0" default="" type="float">gray_value</param>

2097

2098

<insert>cpdf_setgray_stroke(int pdf_document, float gray_value);</insert>

2099

<dialog title="Insert cpdf_setgray_stroke">cpdf_setgray_stroke(%0, %1);</dialog>

2100

2101

</function>

2102

2103

<description>Sets drawing and filling color to gray value</description>

2104

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2105

<param name="gray_value" required="1" vallist="0" default="" type="float">gray_value</param>

2106

2107

<insert>cpdf_setgray(int pdf_document, float gray_value);</insert>

2108

<dialog title="Insert cpdf_setgray">cpdf_setgray(%0, %1);</dialog>

2109

2110

</function>

2111

2112

<description>Sets linecap parameter</description>

2113

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2114

<param name="value" required="1" vallist="0" default="" type="int">value</param>

2115

2116

<insert>cpdf_setlinecap(int pdf_document, int value);</insert>

2117

<dialog title="Insert cpdf_setlinecap">cpdf_setlinecap(%0, %1);</dialog>

2118

2119

</function>

2120

2121

<description>Sets linejoin parameter</description>

2122

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2123

<param name="value" required="1" vallist="0" default="" type="int">value</param>

2124

2125

<insert>cpdf_setlinejoin(int pdf_document, int value);</insert>

2126

<dialog title="Insert cpdf_setlinejoin">cpdf_setlinejoin(%0, %1);</dialog>

2127

2128

</function>

2129

2130

<description>Sets line width</description>

2131

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2132

<param name="width" required="1" vallist="0" default="" type="float">width</param>

2133

2134

<insert>cpdf_setlinewidth(int pdf_document, float width);</insert>

2135

<dialog title="Insert cpdf_setlinewidth">cpdf_setlinewidth(%0, %1);</dialog>

2136

2137

</function>

2138

2139

<description>Sets miter limit</description>

2140

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2141

<param name="value" required="1" vallist="0" default="" type="float">value</param>

2142

2143

<insert>cpdf_setmiterlimit(int pdf_document, float value);</insert>

2144

<dialog title="Insert cpdf_setmiterlimit">cpdf_setmiterlimit(%0, %1);</dialog>

2145

2146

</function>

2147

2148

<description>Sets filling color to rgb color value</description>

2149

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2150

<param name="red_value" required="1" vallist="0" default="" type="float">red_value</param>

2151

<param name="green_value" required="1" vallist="0" default="" type="float">green_value</param>

2152

<param name="blue_value" required="1" vallist="0" default="" type="float">blue_value</param>

2153

2154

<insert>cpdf_setrgbcolor_fill(int pdf_document, float red_value, float green_value, float blue_value);</insert>

2155

<dialog title="Insert cpdf_setrgbcolor_fill">cpdf_setrgbcolor_fill(%0, %1, %2, %3);</dialog>

2156

2157

</function>

2158

2159

<description>Sets drawing color to rgb color value</description>

2160

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2161

<param name="red_value" required="1" vallist="0" default="" type="float">red_value</param>

2162

<param name="green_value" required="1" vallist="0" default="" type="float">green_value</param>

2163

<param name="blue_value" required="1" vallist="0" default="" type="float">blue_value</param>

2164

2165

<insert>cpdf_setrgbcolor_stroke(int pdf_document, float red_value, float green_value, float blue_value);</insert>

2166

<dialog title="Insert cpdf_setrgbcolor_stroke">cpdf_setrgbcolor_stroke(%0, %1, %2, %3);</dialog>

2167

2168

</function>

2169

2170

<description>Sets drawing and filling color to rgb color value</description>

2171

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2172

<param name="red_value" required="1" vallist="0" default="" type="float">red_value</param>

2173

<param name="green_value" required="1" vallist="0" default="" type="float">green_value</param>

2174

<param name="blue_value" required="1" vallist="0" default="" type="float">blue_value</param>

2175

2176

<insert>cpdf_setrgbcolor(int pdf_document, float red_value, float green_value, float blue_value);</insert>

2177

<dialog title="Insert cpdf_setrgbcolor">cpdf_setrgbcolor(%0, %1, %2, %3);</dialog>

2178

2179

</function>

2180

2181

<description>Output text at position</description>

2182

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2183

2184

2185

2186

2187

2188

<insert>cpdf_show_xy(int pdf_document, string text, float x-coor, float y-coor [,int mode]);</insert>

2189

2190

2191

</function>

2192

2193

<description>Output text at current position</description>

2194

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2195

2196

2197

<insert>cpdf_show(int pdf_document, string text);</insert>

2198

2199

2200

</function>

2201

2202

<description>Returns width of text in current font</description>

2203

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2204

2205

<return type="float">float</return>

2206

<insert>cpdf_stringwidth(int pdf_document, string text);</insert>

2207

<dialog title="Insert cpdf_stringwidth">cpdf_stringwidth(%0, %1);</dialog>

2208

2209

</function>

2210

2211

<description>Draw line along path</description>

2212

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2213

2214

<insert>cpdf_stroke(int pdf_document);</insert>

2215

<dialog title="Insert cpdf_stroke">cpdf_stroke(%0);</dialog>

2216

2217

</function>

2218

2219

<description>Output text with parameters</description>

2220

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2221

2222

2223

2224

2225

<param name="orientation" required="0" vallist="0" default="" type="float">orientation</param>

2226

<param name="alignmode" required="0" vallist="0" default="" type="int">alignmode</param>

2227

2228

<insert>cpdf_text(int pdf_document, string text, float x-coor, float y-coor [,int mode] [,float orientation] [,int alignmode]);</insert>

2229

2230

2231

</function>

2232

2233

<description>Sets origin of coordinate system</description>

2234

<param name="pdf_document" required="1" vallist="0" default="" type="int">pdf_document</param>

2235

2236

2237

2238

2239

<insert>cpdf_translate(int pdf_document, float x-coor, float y-coor [,int mode]);</insert>

2240

<dialog title="Insert cpdf_translate">cpdf_translate(%0, %1, %2, %3);</dialog>

2241

2242

</function>

2243

</group>

2244

2245

2246

<description>Performs an obscure check with the given password</description>

2247

<param name="dictionary" required="0" vallist="0" default="" type="resource">dictionary</param>

2248

<param name="password" required="1" vallist="0" default="" type="string">password</param>

2249

2250

<insert>crack_check([resource dictionary], string password);</insert>

2251

<dialog title="Insert crack_check">crack_check(%0, %1);</dialog>

2252

2253

</function>

2254

2255

<description>Closes an open CrackLib dictionary </description>

2256

<param name="dictionary" required="0" vallist="0" default="" type="resource">dictionary</param>

2257

2258

<insert>crack_closedict([resource dictionary]);</insert>

2259

<dialog title="Insert crack_closedict">crack_closedict(%0);</dialog>

2260

2261

</function>

2262

2263

<description>Returns the message from the last obscure check</description>

2264

<return type="string">string</return>

2265

<insert>crack_getlastmessage();</insert>

2266

<dialog title="Insert crack_getlastmessage">crack_getlastmessage();</dialog>

2267

2268

</function>

2269

2270

<description>Opens a new CrackLib dictionary</description>

2271

<param name="dictionary" required="1" vallist="0" default="" type="string">dictionary</param>

2272

<return type="resource">resource</return>

2273

<insert>crack_opendict(string dictionary);</insert>

2274

<dialog title="Insert crack_opendict">crack_opendict(%0);</dialog>

2275

2276

</function>

2277

</group>

2278

2279

2280

<description>Check for alphanumeric character(s)</description>

2281

2282

2283

<insert>ctype_alnum(string text);</insert>

2284

<dialog title="Insert ctype_alnum">ctype_alnum(%0);</dialog>

2285

2286

</function>

2287

2288

<description>Check for alphabetic character(s)</description>

2289

2290

2291

<insert>ctype_alpha(string text);</insert>

2292

<dialog title="Insert ctype_alpha">ctype_alpha(%0);</dialog>

2293

2294

</function>

2295

2296

<description>Check for control character(s)</description>

2297

2298

2299

<insert>ctype_cntrl(string text);</insert>

2300

<dialog title="Insert ctype_cntrl">ctype_cntrl(%0);</dialog>

2301

2302

</function>

2303

2304

<description>Check for numeric character(s)</description>

2305

2306

2307

<insert>ctype_digit(string text);</insert>

2308

<dialog title="Insert ctype_digit">ctype_digit(%0);</dialog>

2309

2310

</function>

2311

2312

<description>Check for any printable character(s) except space</description>

2313

2314

2315

<insert>ctype_graph(string text);</insert>

2316

<dialog title="Insert ctype_graph">ctype_graph(%0);</dialog>

2317

2318

</function>

2319

2320

<description>Check for lowercase character(s)</description>

2321

2322

2323

<insert>ctype_lower(string text);</insert>

2324

<dialog title="Insert ctype_lower">ctype_lower(%0);</dialog>

2325

2326

</function>

2327

2328

<description>Check for printable character(s)</description>

2329

2330

2331

<insert>ctype_print(string text);</insert>

2332

<dialog title="Insert ctype_print">ctype_print(%0);</dialog>

2333

2334

</function>

2335

2336

2337

Check for any printable character which is not whitespace or an

2338

alphanumeric character

2339

</description>

2340

2341

2342

<insert>ctype_punct(string text);</insert>

2343

<dialog title="Insert ctype_punct">ctype_punct(%0);</dialog>

2344

2345

</function>

2346

2347

<description>Check for whitespace character(s)</description>

2348

2349

2350

<insert>ctype_space(string text);</insert>

2351

<dialog title="Insert ctype_space">ctype_space(%0);</dialog>

2352

2353

</function>

2354

2355

<description>Check for uppercase character(s)</description>

2356

2357

2358

<insert>ctype_upper(string text);</insert>

2359

<dialog title="Insert ctype_upper">ctype_upper(%0);</dialog>

2360

2361

</function>

2362

2363

2364

Check for character(s) representing a hexadecimal digit

2365

</description>

2366

2367

2368

<insert>ctype_xdigit(string text);</insert>

2369

<dialog title="Insert ctype_xdigit">ctype_xdigit(%0);</dialog>

2370

2371

</function>

2372

</group>

2373

2374

2375

<description>Close a CURL session</description>

2376

2377

2378

<insert>curl_close(resource ch);</insert>

2379

<dialog title="Insert curl_close">curl_close(%0);</dialog>

2380

2381

</function>

2382

2383

<description>Return the last error number</description>

2384

2385

2386

<insert>curl_errno(resource ch);</insert>

2387

<dialog title="Insert curl_errno">curl_errno(%0);</dialog>

2388

2389

</function>

2390

2391

2392

Return a string containing the last error for the current session

2393

</description>

2394

2395

<return type="string">string</return>

2396

<insert>curl_error(resource ch);</insert>

2397

<dialog title="Insert curl_error">curl_error(%0);</dialog>

2398

2399

</function>

2400

2401

<description>Perform a CURL session</description>

2402

2403

2404

<insert>curl_exec(resource ch);</insert>

2405

2406

2407

</function>

2408

2409

2410

Get information regarding a specific transfer

2411

</description>

2412

2413

2414

<return type="string">string</return>

2415

<insert>curl_getinfo(resource ch [,int opt]);</insert>

2416

<dialog title="Insert curl_getinfo">curl_getinfo(%0, %1);</dialog>

2417

2418

</function>

2419

2420

<description>Initialize a CURL session</description>

2421

2422

<return type="resource">resource</return>

2423

<insert>curl_init([string url]);</insert>

2424

2425

2426

</function>

2427

2428

<description>Set an option for a CURL transfer</description>

2429

2430

<param name="option" required="1" vallist="0" default="" type="string">option</param>

2431

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

2432

2433

<insert>curl_setopt(resource ch, string option, mixed value);</insert>

2434

<dialog title="Insert curl_setopt">curl_setopt(%0, %1, %2);</dialog>

2435

2436

</function>

2437

2438

<description>Return the current CURL version</description>

2439

<return type="string">string</return>

2440

<insert>curl_version();</insert>

2441

<dialog title="Insert curl_version">curl_version();</dialog>

2442

2443

</function>

2444

</group>

2445

2446

2447

<description>base64 decode data for Cybercash</description>

2448

<param name="inbuff" required="1" vallist="0" default="" type="string">inbuff</param>

2449

<return type="string">string</return>

2450

<insert>cybercash_base64_decode(string inbuff);</insert>

2451

<dialog title="Insert cybercash_base64_decode">cybercash_base64_decode(%0);</dialog>

2452

2453

</function>

2454

2455

<description>base64 encode data for Cybercash</description>

2456

<param name="inbuff" required="1" vallist="0" default="" type="string">inbuff</param>

2457

<return type="string">string</return>

2458

<insert>cybercash_base64_encode(string inbuff);</insert>

2459

<dialog title="Insert cybercash_base64_encode">cybercash_base64_encode(%0);</dialog>

2460

2461

</function>

2462

2463

<description>Cybercash decrypt</description>

2464

2465

2466

<param name="inbuff" required="1" vallist="0" default="" type="string">inbuff</param>

2467

<return type="array">array</return>

2468

<insert>cybercash_decr(string wmk, string sk, string inbuff);</insert>

2469

<dialog title="Insert cybercash_decr">cybercash_decr(%0, %1, %2);</dialog>

2470

2471

</function>

2472

2473

<description>Cybercash encrypt</description>

2474

2475

2476

<param name="inbuff" required="1" vallist="0" default="" type="string">inbuff</param>

2477

<return type="array">array</return>

2478

<insert>cybercash_encr(string wmk, string sk, string inbuff);</insert>

2479

<dialog title="Insert cybercash_encr">cybercash_encr(%0, %1, %2);</dialog>

2480

2481

</function>

2482

</group>

2483

2484

2485

<description>Generate HTML form of request for payment</description>

2486

2487

<param name="version" required="1" vallist="0" default="" type="string">version</param>

2488

2489

<param name="montant" required="1" vallist="0" default="" type="string">montant</param>

2490

<param name="ref_commande" required="1" vallist="0" default="" type="string">ref_commande</param>

2491

<param name="texte_libre" required="1" vallist="0" default="" type="string">texte_libre</param>

2492

<param name="url_retour" required="1" vallist="0" default="" type="string">url_retour</param>

2493

<param name="url_retour_ok" required="1" vallist="0" default="" type="string">url_retour_ok</param>

2494

<param name="url_retour_err" required="1" vallist="0" default="" type="string">url_retour_err</param>

2495

<param name="langue" required="1" vallist="0" default="" type="string">langue</param>

2496

<param name="code_societe" required="1" vallist="0" default="" type="string">code_societe</param>

2497

<param name="texte_bouton" required="1" vallist="0" default="" type="string">texte_bouton</param>

2498

<return type="string">string</return>

2499

<insert>cybermut_creerformulairecm(string url_CM, string version, string TPE, string montant, string ref_commande, string texte_libre, string url_retour, string url_retour_ok, string url_retour_err, string langue, string code_societe, string texte_bouton);</insert>

2500

<dialog title="Insert cybermut_creerformulairecm">cybermut_creerformulairecm(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10, %11);</dialog>

2501

2502

</function>

2503

2504

2505

Generate the acknowledgement of delivery of the confirmation

2506

of payment

2507

</description>

2508

<param name="phrase" required="1" vallist="0" default="" type="string">phrase</param>

2509

<return type="string">string</return>

2510

<insert>cybermut_creerreponsecm(string phrase);</insert>

2511

<dialog title="Insert cybermut_creerreponsecm">cybermut_creerreponsecm(%0);</dialog>

2512

2513

</function>

2514

2515

2516

Make sure that there no was data diddling contained

2517

in the received message of confirmation

2518

</description>

2519

2520

<param name="version" required="1" vallist="0" default="" type="string">version</param>

2521

2522

<param name="cdate" required="1" vallist="0" default="" type="string">cdate</param>

2523

<param name="montant" required="1" vallist="0" default="" type="string">montant</param>

2524

<param name="ref_commande" required="1" vallist="0" default="" type="string">ref_commande</param>

2525

<param name="texte_libre" required="1" vallist="0" default="" type="string">texte_libre</param>

2526

<param name="code-retour" required="1" vallist="0" default="" type="string">code-retour</param>

2527

2528

<insert>cybermut_testmac(string code_MAC, string version, string TPE, string cdate, string montant, string ref_commande, string texte_libre, string code-retour);</insert>

2529

<dialog title="Insert cybermut_testmac">cybermut_testmac(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

2530

2531

</function>

2532

</group>

2533

2534

2535

<description>Authenticate against a Cyrus IMAP server </description>

2536

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

2537

<param name="mechlist" required="0" vallist="0" default="" type="string">mechlist</param>

2538

<param name="service" required="0" vallist="0" default="" type="string">service</param>

2539

2540

<param name="minssf" required="0" vallist="0" default="" type="int">minssf</param>

2541

<param name="maxssf" required="0" vallist="0" default="" type="int">maxssf</param>

2542

2543

<insert>cyrus_authenticate(resource connection [,string mechlist] [,string service] [,string user] [,int minssf] [,int maxssf]);</insert>

2544

<dialog title="Insert cyrus_authenticate">cyrus_authenticate(%0, %1, %2, %3, %4, %5);</dialog>

2545

2546

</function>

2547

2548

<description>Bind callbacks to a Cyrus IMAP connection </description>

2549

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

2550

<param name="callbacks" required="1" vallist="0" default="" type="array">callbacks</param>

2551

2552

<insert>cyrus_bind(resource connection, array callbacks);</insert>

2553

<dialog title="Insert cyrus_bind">cyrus_bind(%0, %1);</dialog>

2554

2555

</function>

2556

2557

<description>Close connection to a Cyrus IMAP server </description>

2558

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

2559

2560

<insert>cyrus_close(resource connection);</insert>

2561

<dialog title="Insert cyrus_close">cyrus_close(%0);</dialog>

2562

2563

</function>

2564

2565

<description>Connect to a Cyrus IMAP server </description>

2566

2567

2568

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

2569

<return type="resource">resource</return>

2570

<insert>cyrus_connect([string host] [,string port] [,int flags]);</insert>

2571

<dialog title="Insert cyrus_connect">cyrus_connect(%0, %1, %2);</dialog>

2572

2573

</function>

2574

2575

<description>Send a query to a Cyrus IMAP server </description>

2576

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

2577

<param name="query" required="1" vallist="0" default="" type="string">query</param>

2578

2579

<insert>cyrus_query(resource connection, string query);</insert>

2580

<dialog title="Insert cyrus_query">cyrus_query(%0, %1);</dialog>

2581

2582

</function>

2583

2584

<description>Unbind ... </description>

2585

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

2586

<param name="trigger_name" required="1" vallist="0" default="" type="string">trigger_name</param>

2587

2588

<insert>cyrus_unbind(resource connection, string trigger_name);</insert>

2589

<dialog title="Insert cyrus_unbind">cyrus_unbind(%0, %1);</dialog>

2590

2591

</function>

2592

</group>

2593

2594

2595

<description>Validate a gregorian date</description>

2596

<param name="month" required="1" vallist="0" default="" type="int">month</param>

2597

2598

2599

2600

<insert>checkdate(int month, int day, int year);</insert>

2601

<dialog title="Insert checkdate">checkdate(%0, %1, %2);</dialog>

2602

2603

</function>

2604

2605

<description>Format a local time/date</description>

2606

<param name="format" required="1" vallist="0" default="" type="string">format</param>

2607

<param name="

2608

timestamp

2609

" required="0" vallist="0" default="" type="int">

2610

timestamp

2611

</param>

2612

<return type="string">string</return>

2613

<insert>date(string format [,int

2614

timestamp

2615

]);</insert>

2616

2617

2618

</function>

2619

2620

<description>Get date/time information</description>

2621

<param name="timestamp" required="0" vallist="0" default="" type="int">timestamp</param>

2622

<return type="array">array</return>

2623

<insert>getdate([int timestamp]);</insert>

2624

<dialog title="Insert getdate">getdate(%0);</dialog>

2625

2626

</function>

2627

2628

<description>Get current time</description>

2629

<return type="array">array</return>

2630

<insert>gettimeofday();</insert>

2631

<dialog title="Insert gettimeofday">gettimeofday();</dialog>

2632

2633

</function>

2634

2635

<description>Format a GMT/UTC date/time</description>

2636

<param name="format" required="1" vallist="0" default="" type="string">format</param>

2637

<param name="timestamp" required="0" vallist="0" default="" type="int">timestamp</param>

2638

<return type="string">string</return>

2639

<insert>gmdate(string format [,int timestamp]);</insert>

2640

<dialog title="Insert gmdate">gmdate(%0, %1);</dialog>

2641

2642

</function>

2643

2644

<description>Get UNIX timestamp for a GMT date</description>

2645

2646

<param name="minute" required="1" vallist="0" default="" type="int">minute</param>

2647

<param name="second" required="1" vallist="0" default="" type="int">second</param>

2648

<param name="month" required="1" vallist="0" default="" type="int">month</param>

2649

2650

2651

2652

2653

<insert>gmmktime(int hour, int minute, int second, int month, int day, int year [,int is_dst]);</insert>

2654

<dialog title="Insert gmmktime">gmmktime(%0, %1, %2, %3, %4, %5, %6);</dialog>

2655

2656

</function>

2657

2658

2659

Format a GMT/UTC time/date according to locale settings

2660

</description>

2661

<param name="format" required="1" vallist="0" default="" type="string">format</param>

2662

<param name="timestamp" required="0" vallist="0" default="" type="int">timestamp</param>

2663

<return type="string">string</return>

2664

<insert>gmstrftime(string format [,int timestamp]);</insert>

2665

<dialog title="Insert gmstrftime">gmstrftime(%0, %1);</dialog>

2666

2667

</function>

2668

2669

<description>Get the local time</description>

2670

<param name="

2671

timestamp

2672

" required="0" vallist="0" default="" type="int">

2673

timestamp

2674

</param>

2675

<param name="

2676

is_associative

2677

" required="0" vallist="0" default="" type="bool">

2678

is_associative

2679

</param>

2680

<return type="array">array</return>

2681

<insert>localtime([int

2682

timestamp

2683

] [,bool

2684

is_associative

2685

]);</insert>

2686

<dialog title="Insert localtime">localtime(%0, %1);</dialog>

2687

2688

</function>

2689

2690

2691

Return current UNIX timestamp with microseconds</description>

2692

<return type="string">string</return>

2693

<insert>microtime();</insert>

2694

<dialog title="Insert microtime">microtime();</dialog>

2695

2696

</function>

2697

2698

<description>Get UNIX timestamp for a date</description>

2699

2700

<param name="minute" required="1" vallist="0" default="" type="int">minute</param>

2701

<param name="second" required="1" vallist="0" default="" type="int">second</param>

2702

<param name="month" required="1" vallist="0" default="" type="int">month</param>

2703

2704

2705

2706

2707

<insert>mktime(int hour, int minute, int second, int month, int day, int year [,int is_dst]);</insert>

2708

<dialog title="Insert mktime">mktime(%0, %1, %2, %3, %4, %5, %6);</dialog>

2709

2710

</function>

2711

2712

2713

Format a local time/date according to locale settings

2714

</description>

2715

<param name="format" required="1" vallist="0" default="" type="string">format</param>

2716

<param name="

2717

timestamp

2718

" required="0" vallist="0" default="" type="int">

2719

timestamp

2720

</param>

2721

<return type="string">string</return>

2722

<insert>strftime(string format [,int

2723

timestamp

2724

]);</insert>

2725

<dialog title="Insert strftime">strftime(%0, %1);</dialog>

2726

2727

</function>

2728

2729

2730

Parse about any English textual datetime description into a UNIX

2731

timestamp

2732

</description>

2733

2734

2735

2736

<insert>strtotime(string time [,int now]);</insert>

2737

<dialog title="Insert strtotime">strtotime(%0, %1);</dialog>

2738

2739

</function>

2740

2741

<description>Return current UNIX timestamp</description>

2742

2743

2744

2745

2746

</function>

2747

</group>

2748

2749

2750

<description>Close database</description>

2751

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2752

2753

<insert>dba_close(resource handle);</insert>

2754

<dialog title="Insert dba_close">dba_close(%0);</dialog>

2755

2756

</function>

2757

2758

<description>Delete entry specified by key</description>

2759

2760

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2761

2762

<insert>dba_delete(string key, resource handle);</insert>

2763

<dialog title="Insert dba_delete">dba_delete(%0, %1);</dialog>

2764

2765

</function>

2766

2767

<description>Check whether key exists</description>

2768

2769

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2770

2771

<insert>dba_exists(string key, resource handle);</insert>

2772

<dialog title="Insert dba_exists">dba_exists(%0, %1);</dialog>

2773

2774

</function>

2775

2776

<description>Fetch data specified by key</description>

2777

2778

2779

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2780

<return type="string">string</return>

2781

<insert>dba_fetch(string key [,int skip], resource handle);</insert>

2782

<dialog title="Insert dba_fetch">dba_fetch(%0, %1, %2);</dialog>

2783

2784

</function>

2785

2786

<description>Fetch first key</description>

2787

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2788

<return type="string">string</return>

2789

<insert>dba_firstkey(resource handle);</insert>

2790

<dialog title="Insert dba_firstkey">dba_firstkey(%0);</dialog>

2791

2792

</function>

2793

2794

<description>List handlers available</description>

2795

<return type="array">array</return>

2796

<insert>dba_handlers();</insert>

2797

<dialog title="Insert dba_handlers">dba_handlers();</dialog>

2798

2799

</function>

2800

2801

<description>Insert entry</description>

2802

2803

<param name="value" required="1" vallist="0" default="" type="string">value</param>

2804

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2805

2806

<insert>dba_insert(string key, string value, resource handle);</insert>

2807

<dialog title="Insert dba_insert">dba_insert(%0, %1, %2);</dialog>

2808

2809

</function>

2810

2811

<description>List all open database files</description>

2812

<return type="array">array</return>

2813

2814

2815

2816

</function>

2817

2818

<description>Fetch next key</description>

2819

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2820

<return type="string">string</return>

2821

<insert>dba_nextkey(resource handle);</insert>

2822

<dialog title="Insert dba_nextkey">dba_nextkey(%0);</dialog>

2823

2824

</function>

2825

2826

<description>Open database</description>

2827

2828

2829

<param name="handler" required="1" vallist="0" default="" type="string">handler</param>

2830

<return type="resource">resource</return>

2831

<insert>dba_open(string path, string mode, string handler);</insert>

2832

2833

2834

</function>

2835

2836

<description>Optimize database</description>

2837

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2838

2839

<insert>dba_optimize(resource handle);</insert>

2840

<dialog title="Insert dba_optimize">dba_optimize(%0);</dialog>

2841

2842

</function>

2843

2844

<description>Open database persistently</description>

2845

2846

2847

<param name="handler" required="1" vallist="0" default="" type="string">handler</param>

2848

<return type="resource">resource</return>

2849

<insert>dba_popen(string path, string mode, string handler);</insert>

2850

<dialog title="Insert dba_popen">dba_popen(%0, %1, %2);</dialog>

2851

2852

</function>

2853

2854

<description>Replace or insert entry</description>

2855

2856

<param name="value" required="1" vallist="0" default="" type="string">value</param>

2857

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2858

2859

<insert>dba_replace(string key, string value, resource handle);</insert>

2860

<dialog title="Insert dba_replace">dba_replace(%0, %1, %2);</dialog>

2861

2862

</function>

2863

2864

<description>Synchronize database</description>

2865

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

2866

2867

<insert>dba_sync(resource handle);</insert>

2868

2869

2870

</function>

2871

</group>

2872

2873

2874

<description>Add a record to a dBase database</description>

2875

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2876

<param name="record" required="1" vallist="0" default="" type="array">record</param>

2877

2878

<insert>dbase_add_record(int dbase_identifier, array record);</insert>

2879

<dialog title="Insert dbase_add_record">dbase_add_record(%0, %1);</dialog>

2880

2881

</function>

2882

2883

<description>Close a dBase database</description>

2884

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2885

2886

<insert>dbase_close(int dbase_identifier);</insert>

2887

<dialog title="Insert dbase_close">dbase_close(%0);</dialog>

2888

2889

</function>

2890

2891

<description>Creates a dBase database</description>

2892

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

2893

<param name="fields" required="1" vallist="0" default="" type="array">fields</param>

2894

2895

<insert>dbase_create(string filename, array fields);</insert>

2896

<dialog title="Insert dbase_create">dbase_create(%0, %1);</dialog>

2897

2898

</function>

2899

2900

<description>Deletes a record from a dBase database</description>

2901

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2902

<param name="record" required="1" vallist="0" default="" type="int">record</param>

2903

2904

<insert>dbase_delete_record(int dbase_identifier, int record);</insert>

2905

<dialog title="Insert dbase_delete_record">dbase_delete_record(%0, %1);</dialog>

2906

2907

</function>

2908

2909

2910

Gets a record from a dBase database as an associative array

2911

</description>

2912

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2913

<param name="record" required="1" vallist="0" default="" type="int">record</param>

2914

<return type="array">array</return>

2915

<insert>dbase_get_record_with_names(int dbase_identifier, int record);</insert>

2916

<dialog title="Insert dbase_get_record_with_names">dbase_get_record_with_names(%0, %1);</dialog>

2917

2918

</function>

2919

2920

<description>Gets a record from a dBase database</description>

2921

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2922

<param name="record" required="1" vallist="0" default="" type="int">record</param>

2923

<return type="array">array</return>

2924

<insert>dbase_get_record(int dbase_identifier, int record);</insert>

2925

<dialog title="Insert dbase_get_record">dbase_get_record(%0, %1);</dialog>

2926

2927

</function>

2928

2929

2930

Find out how many fields are in a dBase database

2931

</description>

2932

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2933

2934

<insert>dbase_numfields(int dbase_identifier);</insert>

2935

<dialog title="Insert dbase_numfields">dbase_numfields(%0);</dialog>

2936

2937

</function>

2938

2939

2940

Find out how many records are in a dBase database

2941

</description>

2942

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2943

2944

<insert>dbase_numrecords(int dbase_identifier);</insert>

2945

<dialog title="Insert dbase_numrecords">dbase_numrecords(%0);</dialog>

2946

2947

</function>

2948

2949

<description>Opens a dBase database</description>

2950

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

2951

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

2952

2953

<insert>dbase_open(string filename, int flags);</insert>

2954

<dialog title="Insert dbase_open">dbase_open(%0, %1);</dialog>

2955

2956

</function>

2957

2958

<description>Packs a dBase database</description>

2959

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2960

2961

<insert>dbase_pack(int dbase_identifier);</insert>

2962

<dialog title="Insert dbase_pack">dbase_pack(%0);</dialog>

2963

2964

</function>

2965

2966

<description>Replace a record in a dBase database</description>

2967

<param name="dbase_identifier" required="1" vallist="0" default="" type="int">dbase_identifier</param>

2968

<param name="record" required="1" vallist="0" default="" type="array">record</param>

2969

<param name="dbase_record_number" required="1" vallist="0" default="" type="int">dbase_record_number</param>

2970

2971

<insert>dbase_replace_record(int dbase_identifier, array record, int dbase_record_number);</insert>

2972

<dialog title="Insert dbase_replace_record">dbase_replace_record(%0, %1, %2);</dialog>

2973

2974

</function>

2975

</group>

2976

2977

2978

2979

Describes the DBM-compatible library being used

2980

</description>

2981

<return type="string">string</return>

2982

<insert>dblist();</insert>

2983

<dialog title="Insert dblist">dblist();</dialog>

2984

2985

</function>

2986

2987

<description>Closes a dbm database</description>

2988

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

2989

2990

<insert>dbmclose(resource dbm_identifier);</insert>

2991

<dialog title="Insert dbmclose">dbmclose(%0);</dialog>

2992

2993

</function>

2994

2995

2996

Deletes the value for a key from a DBM database

2997

</description>

2998

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

2999

3000

3001

<insert>dbmdelete(resource dbm_identifier, string key);</insert>

3002

<dialog title="Insert dbmdelete">dbmdelete(%0, %1);</dialog>

3003

3004

</function>

3005

3006

3007

Tells if a value exists for a key in a DBM database

3008

</description>

3009

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3010

3011

3012

<insert>dbmexists(resource dbm_identifier, string key);</insert>

3013

<dialog title="Insert dbmexists">dbmexists(%0, %1);</dialog>

3014

3015

</function>

3016

3017

3018

Fetches a value for a key from a DBM database

3019

</description>

3020

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3021

3022

<return type="string">string</return>

3023

<insert>dbmfetch(resource dbm_identifier, string key);</insert>

3024

<dialog title="Insert dbmfetch">dbmfetch(%0, %1);</dialog>

3025

3026

</function>

3027

3028

3029

Retrieves the first key from a DBM database

3030

</description>

3031

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3032

<return type="string">string</return>

3033

<insert>dbmfirstkey(resource dbm_identifier);</insert>

3034

<dialog title="Insert dbmfirstkey">dbmfirstkey(%0);</dialog>

3035

3036

</function>

3037

3038

3039

Inserts a value for a key in a DBM database

3040

</description>

3041

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3042

3043

<param name="value" required="1" vallist="0" default="" type="string">value</param>

3044

3045

<insert>dbminsert(resource dbm_identifier, string key, string value);</insert>

3046

<dialog title="Insert dbminsert">dbminsert(%0, %1, %2);</dialog>

3047

3048

</function>

3049

3050

3051

Retrieves the next key from a DBM database</description>

3052

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3053

3054

<return type="string">string</return>

3055

<insert>dbmnextkey(resource dbm_identifier, string key);</insert>

3056

<dialog title="Insert dbmnextkey">dbmnextkey(%0, %1);</dialog>

3057

3058

</function>

3059

3060

<description>Opens a DBM database</description>

3061

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

3062

<param name="flags" required="1" vallist="0" default="" type="string">flags</param>

3063

<return type="resource">resource</return>

3064

<insert>dbmopen(string filename, string flags);</insert>

3065

<dialog title="Insert dbmopen">dbmopen(%0, %1);</dialog>

3066

3067

</function>

3068

3069

3070

Replaces the value for a key in a DBM database

3071

</description>

3072

<param name="dbm_identifier" required="1" vallist="0" default="" type="resource">dbm_identifier</param>

3073

3074

<param name="value" required="1" vallist="0" default="" type="string">value</param>

3075

3076

<insert>dbmreplace(resource dbm_identifier, string key, string value);</insert>

3077

<dialog title="Insert dbmreplace">dbmreplace(%0, %1, %2);</dialog>

3078

3079

</function>

3080

</group>

3081

3082

3083

<description>Add a tuple to a relation</description>

3084

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3085

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3086

3087

<insert>dbplus_add(resource relation, array tuple);</insert>

3088

<dialog title="Insert dbplus_add">dbplus_add(%0, %1);</dialog>

3089

3090

</function>

3091

3092

<description>Perform AQL query</description>

3093

<param name="query" required="1" vallist="0" default="" type="string">query</param>

3094

<param name="server" required="0" vallist="0" default="" type="string">server</param>

3095

<param name="dbpath" required="0" vallist="0" default="" type="string">dbpath</param>

3096

<return type="resource">resource</return>

3097

<insert>dbplus_aql(string query [,string server] [,string dbpath]);</insert>

3098

<dialog title="Insert dbplus_aql">dbplus_aql(%0, %1, %2);</dialog>

3099

3100

</function>

3101

3102

<description>Get/Set database virtual current directory</description>

3103

<param name="newdir" required="0" vallist="0" default="" type="string">newdir</param>

3104

<return type="string">string</return>

3105

<insert>dbplus_chdir([string newdir]);</insert>

3106

<dialog title="Insert dbplus_chdir">dbplus_chdir(%0);</dialog>

3107

3108

</function>

3109

3110

<description>Close a relation</description>

3111

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3112

3113

<insert>dbplus_close(resource relation);</insert>

3114

<dialog title="Insert dbplus_close">dbplus_close(%0);</dialog>

3115

3116

</function>

3117

3118

<description>Get current tuple from relation</description>

3119

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3120

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3121

3122

<insert>dbplus_curr(resource relation, array tuple);</insert>

3123

<dialog title="Insert dbplus_curr">dbplus_curr(%0, %1);</dialog>

3124

3125

</function>

3126

3127

3128

Get error string for given errorcode or last error

3129

</description>

3130

<param name="errno" required="1" vallist="0" default="" type="int">errno</param>

3131

<return type="string">string</return>

3132

<insert>dbplus_errcode(int errno);</insert>

3133

<dialog title="Insert dbplus_errcode">dbplus_errcode(%0);</dialog>

3134

3135

</function>

3136

3137

<description>Get error code for last operation</description>

3138

3139

<insert>dbplus_errno();</insert>

3140

<dialog title="Insert dbplus_errno">dbplus_errno();</dialog>

3141

3142

</function>

3143

3144

<description>Set a constraint on a relation</description>

3145

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3146

<param name="constraints" required="1" vallist="0" default="" type="array">constraints</param>

3147

<param name="tuple" required="1" vallist="0" default="" type="mixed">tuple</param>

3148

3149

<insert>dbplus_find(resource relation, array constraints, mixed tuple);</insert>

3150

<dialog title="Insert dbplus_find">dbplus_find(%0, %1, %2);</dialog>

3151

3152

</function>

3153

3154

<description>Get first tuple from relation</description>

3155

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3156

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3157

3158

<insert>dbplus_first(resource relation, array tuple);</insert>

3159

<dialog title="Insert dbplus_first">dbplus_first(%0, %1);</dialog>

3160

3161

</function>

3162

3163

<description>Flush all changes made on a relation</description>

3164

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3165

3166

<insert>dbplus_flush(resource relation);</insert>

3167

<dialog title="Insert dbplus_flush">dbplus_flush(%0);</dialog>

3168

3169

</function>

3170

3171

<description>Free all locks held by this client</description>

3172

3173

<insert>dbplus_freealllocks();</insert>

3174

<dialog title="Insert dbplus_freealllocks">dbplus_freealllocks();</dialog>

3175

3176

</function>

3177

3178

<description>Release write lock on tuple</description>

3179

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3180

<param name="tname" required="1" vallist="0" default="" type="string">tname</param>

3181

3182

<insert>dbplus_freelock(resource relation, string tname);</insert>

3183

<dialog title="Insert dbplus_freelock">dbplus_freelock(%0, %1);</dialog>

3184

3185

</function>

3186

3187

<description>Free all tuple locks on given relation</description>

3188

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3189

3190

<insert>dbplus_freerlocks(resource relation);</insert>

3191

<dialog title="Insert dbplus_freerlocks">dbplus_freerlocks(%0);</dialog>

3192

3193

</function>

3194

3195

<description>Get a write lock on a tuple</description>

3196

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3197

<param name="tname" required="1" vallist="0" default="" type="string">tname</param>

3198

3199

<insert>dbplus_getlock(resource relation, string tname);</insert>

3200

<dialog title="Insert dbplus_getlock">dbplus_getlock(%0, %1);</dialog>

3201

3202

</function>

3203

3204

<description>Get a id number unique to a relation</description>

3205

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3206

<param name="uniqueid" required="1" vallist="0" default="" type="int">uniqueid</param>

3207

3208

<insert>dbplus_getunique(resource relation, int uniqueid);</insert>

3209

<dialog title="Insert dbplus_getunique">dbplus_getunique(%0, %1);</dialog>

3210

3211

</function>

3212

3213

3214

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3215

3216

3217

<insert>dbplus_info(resource relation, string key);</insert>

3218

<dialog title="Insert dbplus_info">dbplus_info(%0, %1);</dialog>

3219

3220

</function>

3221

3222

<description>Get last tuple from relation</description>

3223

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3224

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3225

3226

<insert>dbplus_last(resource relation, array tuple);</insert>

3227

<dialog title="Insert dbplus_last">dbplus_last(%0, %1);</dialog>

3228

3229

</function>

3230

3231

<description>Request write lock on relation</description>

3232

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3233

3234

<insert>dbplus_lockrel(resource relation);</insert>

3235

<dialog title="Insert dbplus_lockrel">dbplus_lockrel(%0);</dialog>

3236

3237

</function>

3238

3239

<description>Get next tuple from relation</description>

3240

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3241

3242

<insert>dbplus_next(resource relation);</insert>

3243

<dialog title="Insert dbplus_next">dbplus_next(%0);</dialog>

3244

3245

</function>

3246

3247

<description>Open relation file</description>

3248

3249

<return type="resource">resource</return>

3250

<insert>dbplus_open(string name);</insert>

3251

<dialog title="Insert dbplus_open">dbplus_open(%0);</dialog>

3252

3253

</function>

3254

3255

<description>Get previous tuple from relation</description>

3256

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3257

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3258

3259

<insert>dbplus_prev(resource relation, array tuple);</insert>

3260

<dialog title="Insert dbplus_prev">dbplus_prev(%0, %1);</dialog>

3261

3262

</function>

3263

3264

<description>Change relation permissions</description>

3265

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3266

3267

3268

<param name="group" required="1" vallist="0" default="" type="string">group</param>

3269

3270

<insert>dbplus_rchperm(resource relation, int mask, string user, string group);</insert>

3271

<dialog title="Insert dbplus_rchperm">dbplus_rchperm(%0, %1, %2, %3);</dialog>

3272

3273

</function>

3274

3275

<description>Creates a new DB++ relation</description>

3276

3277

<param name="domlist" required="1" vallist="0" default="" type="mixed">domlist</param>

3278

<param name="overwrite" required="0" vallist="0" default="" type="bool">overwrite</param>

3279

<return type="resource">resource</return>

3280

<insert>dbplus_rcreate(string name, mixed domlist [,bool overwrite]);</insert>

3281

<dialog title="Insert dbplus_rcreate">dbplus_rcreate(%0, %1, %2);</dialog>

3282

3283

</function>

3284

3285

<description>Creates an exact but empty copy of a relation including indices</description>

3286

3287

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3288

<param name="overwrite" required="1" vallist="0" default="" type="bool">overwrite</param>

3289

<return type="resource">resource</return>

3290

<insert>dbplus_rcrtexact(string name, resource relation, bool overwrite);</insert>

3291

<dialog title="Insert dbplus_rcrtexact">dbplus_rcrtexact(%0, %1, %2);</dialog>

3292

3293

</function>

3294

3295

<description>Creates an empty copy of a relation with default indices</description>

3296

3297

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3298

3299

<return type="resource">resource</return>

3300

<insert>dbplus_rcrtlike(string name, resource relation, int flag);</insert>

3301

<dialog title="Insert dbplus_rcrtlike">dbplus_rcrtlike(%0, %1, %2);</dialog>

3302

3303

</function>

3304

3305

<description>Resolve host information for relation</description>

3306

<param name="relation_name" required="1" vallist="0" default="" type="string">relation_name</param>

3307

3308

<insert>dbplus_resolve(string relation_name);</insert>

3309

<dialog title="Insert dbplus_resolve">dbplus_resolve(%0);</dialog>

3310

3311

</function>

3312

3313

3314

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3315

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3316

3317

<insert>dbplus_restorepos(resource relation, array tuple);</insert>

3318

<dialog title="Insert dbplus_restorepos">dbplus_restorepos(%0, %1);</dialog>

3319

3320

</function>

3321

3322

<description>Specify new primary key for a relation</description>

3323

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3324

<param name="domlist" required="1" vallist="0" default="" type="mixed">domlist</param>

3325

<return type="resource">resource</return>

3326

<insert>dbplus_rkeys(resource relation, mixed domlist);</insert>

3327

<dialog title="Insert dbplus_rkeys">dbplus_rkeys(%0, %1);</dialog>

3328

3329

</function>

3330

3331

<description>Open relation file local</description>

3332

3333

<return type="resource">resource</return>

3334

<insert>dbplus_ropen(string name);</insert>

3335

<dialog title="Insert dbplus_ropen">dbplus_ropen(%0);</dialog>

3336

3337

</function>

3338

3339

<description>Perform local (raw) AQL query</description>

3340

<param name="query" required="1" vallist="0" default="" type="string">query</param>

3341

<param name="dbpath" required="1" vallist="0" default="" type="string">dbpath</param>

3342

3343

<insert>dbplus_rquery(string query, string dbpath);</insert>

3344

<dialog title="Insert dbplus_rquery">dbplus_rquery(%0, %1);</dialog>

3345

3346

</function>

3347

3348

<description>Rename a relation</description>

3349

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3350

3351

3352

<insert>dbplus_rrename(resource relation, string name);</insert>

3353

<dialog title="Insert dbplus_rrename">dbplus_rrename(%0, %1);</dialog>

3354

3355

</function>

3356

3357

3358

Create a new secondary index for a relation

3359

</description>

3360

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3361

<param name="domlist" required="1" vallist="0" default="" type="mixed">domlist</param>

3362

3363

<return type="resource">resource</return>

3364

<insert>dbplus_rsecindex(resource relation, mixed domlist, int type);</insert>

3365

<dialog title="Insert dbplus_rsecindex">dbplus_rsecindex(%0, %1, %2);</dialog>

3366

3367

</function>

3368

3369

<description>Remove relation from filesystem</description>

3370

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3371

3372

<insert>dbplus_runlink(resource relation);</insert>

3373

<dialog title="Insert dbplus_runlink">dbplus_runlink(%0);</dialog>

3374

3375

</function>

3376

3377

<description>Remove all tuples from relation</description>

3378

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3379

3380

<insert>dbplus_rzap(resource relation);</insert>

3381

<dialog title="Insert dbplus_rzap">dbplus_rzap(%0);</dialog>

3382

3383

</function>

3384

3385

3386

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3387

3388

<insert>dbplus_savepos(resource relation);</insert>

3389

<dialog title="Insert dbplus_savepos">dbplus_savepos(%0);</dialog>

3390

3391

</function>

3392

3393

3394

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3395

3396

3397

<insert>dbplus_setindex(resource relation, string idx_name);</insert>

3398

<dialog title="Insert dbplus_setindex">dbplus_setindex(%0, %1);</dialog>

3399

3400

</function>

3401

3402

3403

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3404

<param name="idx_number" required="1" vallist="0" default="" type="int">idx_number</param>

3405

3406

<insert>dbplus_setindexbynumber(resource relation, int idx_number);</insert>

3407

<dialog title="Insert dbplus_setindexbynumber">dbplus_setindexbynumber(%0, %1);</dialog>

3408

3409

</function>

3410

3411

<description>Perform SQL query</description>

3412

<param name="query" required="1" vallist="0" default="" type="string">query</param>

3413

<param name="server" required="1" vallist="0" default="" type="string">server</param>

3414

<param name="dbpath" required="1" vallist="0" default="" type="string">dbpath</param>

3415

<return type="resource">resource</return>

3416

<insert>dbplus_sql(string query, string server, string dbpath);</insert>

3417

<dialog title="Insert dbplus_sql">dbplus_sql(%0, %1, %2);</dialog>

3418

3419

</function>

3420

3421

<description>Execute TCL code on server side</description>

3422

3423

<param name="script" required="1" vallist="0" default="" type="string">script</param>

3424

3425

<insert>dbplus_tcl(int sid, string script);</insert>

3426

<dialog title="Insert dbplus_tcl">dbplus_tcl(%0, %1);</dialog>

3427

3428

</function>

3429

3430

<description>Remove tuple and return new current tuple</description>

3431

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3432

<param name="tuple" required="1" vallist="0" default="" type="array">tuple</param>

3433

<param name="current" required="0" vallist="0" default="" type="array">current</param>

3434

3435

<insert>dbplus_tremove(resource relation, array tuple [,array current]);</insert>

3436

<dialog title="Insert dbplus_tremove">dbplus_tremove(%0, %1, %2);</dialog>

3437

3438

</function>

3439

3440

3441

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3442

3443

<insert>dbplus_undo(resource relation);</insert>

3444

<dialog title="Insert dbplus_undo">dbplus_undo(%0);</dialog>

3445

3446

</function>

3447

3448

3449

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3450

3451

<insert>dbplus_undoprepare(resource relation);</insert>

3452

<dialog title="Insert dbplus_undoprepare">dbplus_undoprepare(%0);</dialog>

3453

3454

</function>

3455

3456

<description>Give up write lock on relation</description>

3457

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3458

3459

<insert>dbplus_unlockrel(resource relation);</insert>

3460

<dialog title="Insert dbplus_unlockrel">dbplus_unlockrel(%0);</dialog>

3461

3462

</function>

3463

3464

<description>Remove a constraint from relation</description>

3465

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3466

3467

<insert>dbplus_unselect(resource relation);</insert>

3468

<dialog title="Insert dbplus_unselect">dbplus_unselect(%0);</dialog>

3469

3470

</function>

3471

3472

<description>Update specified tuple in relation</description>

3473

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3474

3475

3476

3477

<insert>dbplus_update(resource relation, array old, array new);</insert>

3478

<dialog title="Insert dbplus_update">dbplus_update(%0, %1, %2);</dialog>

3479

3480

</function>

3481

3482

<description>Request exclusive lock on relation</description>

3483

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3484

3485

<insert>dbplus_xlockrel(resource relation);</insert>

3486

<dialog title="Insert dbplus_xlockrel">dbplus_xlockrel(%0);</dialog>

3487

3488

</function>

3489

3490

<description>Free exclusive lock on relation</description>

3491

<param name="relation" required="1" vallist="0" default="" type="resource">relation</param>

3492

3493

<insert>dbplus_xunlockrel(resource relation);</insert>

3494

<dialog title="Insert dbplus_xunlockrel">dbplus_xunlockrel(%0);</dialog>

3495

3496

</function>

3497

</group>

3498

3499

3500

<description>Close an open connection/database</description>

3501

<param name="link_identifier" required="1" vallist="0" default="" type="object">link_identifier</param>

3502

3503

<insert>dbx_close(object link_identifier);</insert>

3504

<dialog title="Insert dbx_close">dbx_close(%0);</dialog>

3505

3506

</function>

3507

3508

<description>Compare two rows for sorting purposes</description>

3509

3510

3511

<param name="column_key" required="1" vallist="0" default="" type="string">column_key</param>

3512

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

3513

3514

<insert>dbx_compare(array row_a, array row_b, string column_key [,int flags]);</insert>

3515

<dialog title="Insert dbx_compare">dbx_compare(%0, %1, %2, %3);</dialog>

3516

3517

</function>

3518

3519

<description>Open a connection/database</description>

3520

<param name="module" required="1" vallist="0" default="" type="mixed">module</param>

3521

3522

<param name="database" required="1" vallist="0" default="" type="string">database</param>

3523

<param name="username" required="1" vallist="0" default="" type="string">username</param>

3524

<param name="password" required="1" vallist="0" default="" type="string">password</param>

3525

<param name="persistent" required="0" vallist="0" default="" type="int">persistent</param>

3526

<return type="object">object</return>

3527

<insert>dbx_connect(mixed module, string host, string database, string username, string password [,int persistent]);</insert>

3528

<dialog title="Insert dbx_connect">dbx_connect(%0, %1, %2, %3, %4, %5);</dialog>

3529

3530

</function>

3531

3532

3533

Report the error message of the latest function call in the

3534

module (not just in the connection)

3535

</description>

3536

<param name="link_identifier" required="1" vallist="0" default="" type="object">link_identifier</param>

3537

<return type="string">string</return>

3538

<insert>dbx_error(object link_identifier);</insert>

3539

<dialog title="Insert dbx_error">dbx_error(%0);</dialog>

3540

3541

</function>

3542

3543

3544

Escape a string so it can safely be used in an sql-statement.

3545

</description>

3546

<param name="link_identifier" required="1" vallist="0" default="" type="object">link_identifier</param>

3547

3548

<return type="string">string</return>

3549

<insert>dbx_escape_string(object link_identifier, string text);</insert>

3550

<dialog title="Insert dbx_escape_string">dbx_escape_string(%0, %1);</dialog>

3551

3552

</function>

3553

3554

<description>Send a query and fetch all results (if any)</description>

3555

<param name="link_identifier" required="1" vallist="0" default="" type="object">link_identifier</param>

3556

<param name="sql_statement" required="1" vallist="0" default="" type="string">sql_statement</param>

3557

<param name="flags" required="0" vallist="0" default="" type="long">flags</param>

3558

<return type="object">object</return>

3559

<insert>dbx_query(object link_identifier, string sql_statement [,long flags]);</insert>

3560

<dialog title="Insert dbx_query">dbx_query(%0, %1, %2);</dialog>

3561

3562

</function>

3563

3564

3565

Sort a result from a dbx_query by a custom sort function

3566

</description>

3567

<param name="result" required="1" vallist="0" default="" type="object">result</param>

3568

<param name="user_compare_function" required="1" vallist="0" default="" type="string">user_compare_function</param>

3569

3570

<insert>dbx_sort(object result, string user_compare_function);</insert>

3571

3572

3573

</function>

3574

</group>

3575

3576

3577

<description>Closes the file descriptor given by fd</description>

3578

3579

3580

<insert>dio_close(resource fd);</insert>

3581

<dialog title="Insert dio_close">dio_close(%0);</dialog>

3582

3583

</function>

3584

3585

<description>Performs a c library fcntl on fd</description>

3586

3587

3588

3589

<return type="mixed">mixed</return>

3590

<insert>dio_fcntl(resource fd, int cmd [,mixed arg]);</insert>

3591

<dialog title="Insert dio_fcntl">dio_fcntl(%0, %1, %2);</dialog>

3592

3593

</function>

3594

3595

3596

Opens a new filename with specified permissions of flags and

3597

creation permissions of mode

3598

</description>

3599

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

3600

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

3601

3602

<return type="resource">resource</return>

3603

<insert>dio_open(string filename, int flags [,int mode]);</insert>

3604

3605

3606

</function>

3607

3608

3609

Reads n bytes from fd and returns them, if n is not specified,

3610

reads 1k block

3611

</description>

3612

3613

3614

<return type="string">string</return>

3615

<insert>dio_read(resource fd [,int n]);</insert>

3616

3617

3618

</function>

3619

3620

<description>Seeks to pos on fd from whence</description>

3621

3622

3623

<param name="whence" required="1" vallist="0" default="" type="int">whence</param>

3624

3625

<insert>dio_seek(resource fd, int pos, int whence);</insert>

3626

3627

3628

</function>

3629

3630

3631

Gets stat information about the file descriptor fd

3632

</description>

3633

3634

<return type="array">array</return>

3635

<insert>dio_stat(resource fd);</insert>

3636

3637

3638

</function>

3639

3640

3641

Sets terminal attributes and baud rate for a serial port

3642

</description>

3643

3644

<param name="options" required="1" vallist="0" default="" type="array">options</param>

3645

3646

<insert>dio_tcsetattr(resource fd, array options);</insert>

3647

<dialog title="Insert dio_tcsetattr">dio_tcsetattr(%0, %1);</dialog>

3648

3649

</function>

3650

3651

3652

Truncates file descriptor fd to offset bytes

3653

</description>

3654

3655

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

3656

3657

<insert>dio_truncate(resource fd, int offset);</insert>

3658

<dialog title="Insert dio_truncate">dio_truncate(%0, %1);</dialog>

3659

3660

</function>

3661

3662

3663

Writes data to fd with optional truncation at length

3664

</description>

3665

3666

3667

3668

3669

<insert>dio_write(resource fd, string data [,int len]);</insert>

3670

<dialog title="Insert dio_write">dio_write(%0, %1, %2);</dialog>

3671

3672

</function>

3673

</group>

3674

3675

3676

<description>Change directory</description>

3677

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

3678

3679

<insert>chdir(string directory);</insert>

3680

<dialog title="Insert chdir">chdir(%0);</dialog>

3681

3682

</function>

3683

3684

<description>Change the root directory</description>

3685

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

3686

3687

<insert>chroot(string directory);</insert>

3688

<dialog title="Insert chroot">chroot(%0);</dialog>

3689

3690

</function>

3691

3692

<description>close directory handle</description>

3693

<param name="dir_handle" required="1" vallist="0" default="" type="resource">dir_handle</param>

3694

3695

<insert>closedir(resource dir_handle);</insert>

3696

<dialog title="Insert closedir">closedir(%0);</dialog>

3697

3698

</function>

3699

3700

<description>gets the current working directory</description>

3701

<return type="string">string</return>

3702

<insert>getcwd();</insert>

3703

<dialog title="Insert getcwd">getcwd();</dialog>

3704

3705

</function>

3706

3707

<description>open directory handle</description>

3708

3709

<return type="resource">resource</return>

3710

<insert>opendir(string path);</insert>

3711

<dialog title="Insert opendir">opendir(%0);</dialog>

3712

3713

</function>

3714

3715

<description>read entry from directory handle</description>

3716

<param name="dir_handle" required="1" vallist="0" default="" type="resource">dir_handle</param>

3717

<return type="string">string</return>

3718

<insert>readdir(resource dir_handle);</insert>

3719

<dialog title="Insert readdir">readdir(%0);</dialog>

3720

3721

</function>

3722

3723

<description>rewind directory handle</description>

3724

<param name="dir_handle" required="1" vallist="0" default="" type="resource">dir_handle</param>

3725

3726

<insert>rewinddir(resource dir_handle);</insert>

3727

<dialog title="Insert rewinddir">rewinddir(%0);</dialog>

3728

3729

</function>

3730

</group>

3731

3732

3733

3734

Returns name of attribute

3735

</description>

3736

3737

<insert>DomAttribute->name();</insert>

3738

<dialog title="Insert DomAttribute->name">DomAttribute->name();</dialog>

3739

3740

</function>

3741

<function name="DomAttribute->specified">

3742

3743

Checks if attribute is specified

3744

</description>

3745

3746

<insert>DomAttribute->specified();</insert>

3747

<dialog title="Insert DomAttribute->specified">DomAttribute->specified();</dialog>

3748

3749

</function>

3750

<function name="DomAttribute->value">

3751

3752

Returns value of attribute

3753

</description>

3754

3755

<insert>DomAttribute->value();</insert>

3756

<dialog title="Insert DomAttribute->value">DomAttribute->value();</dialog>

3757

3758

</function>

3759

<function name="DomDocument->add_root [deprecated]">

3760

3761

Adds a root node

3762

</description>

3763

3764

<return type="resource">resource</return>

3765

<insert>DomDocument->add_root [deprecated](string name);</insert>

3766

<dialog title="Insert DomDocument->add_root [deprecated]">DomDocument->add_root [deprecated](%0);</dialog>

3767

3768

</function>

3769

<function name="DomDocument->create_attribute">

3770

<description>Create new attribute</description>

3771

3772

<param name="value" required="1" vallist="0" default="" type="string">value</param>

3773

<return type="object">object</return>

3774

<insert>DomDocument->create_attribute(string name, string value);</insert>

3775

<dialog title="Insert DomDocument->create_attribute">DomDocument->create_attribute(%0, %1);</dialog>

3776

3777

</function>

3778

<function name="DomDocument->create_cdata_section">

3779

<description>Create new cdata node</description>

3780

<param name="content" required="1" vallist="0" default="" type="string">content</param>

3781

<return type="string">string</return>

3782

<insert>DomDocument->create_cdata_section(string content);</insert>

3783

<dialog title="Insert DomDocument->create_cdata_section">DomDocument->create_cdata_section(%0);</dialog>

3784

3785

</function>

3786

<function name="DomDocument->create_comment">

3787

<description>Create new comment node</description>

3788

<param name="content" required="1" vallist="0" default="" type="string">content</param>

3789

<return type="object">object</return>

3790

<insert>DomDocument->create_comment(string content);</insert>

3791

<dialog title="Insert DomDocument->create_comment">DomDocument->create_comment(%0);</dialog>

3792

3793

</function>

3794

<function name="DomDocument->create_element_ns">

3795

3796

Create new element node with an associated namespace

3797

</description>

3798

3799

3800

<param name="prefix" required="0" vallist="0" default="" type="string">prefix</param>

3801

<return type="object">object</return>

3802

<insert>DomDocument->create_element_ns(string uri, string name [,string prefix]);</insert>

3803

<dialog title="Insert DomDocument->create_element_ns">DomDocument->create_element_ns(%0, %1, %2);</dialog>

3804

3805

</function>

3806

<function name="DomDocument->create_element">

3807

<description>Create new element node</description>

3808

3809

<return type="object">object</return>

3810

<insert>DomDocument->create_element(string name);</insert>

3811

<dialog title="Insert DomDocument->create_element">DomDocument->create_element(%0);</dialog>

3812

3813

</function>

3814

<function name="DomDocument->create_entity_reference">

3815

3816

</description>

3817

<param name="content" required="1" vallist="0" default="" type="string">content</param>

3818

<return type="object">object</return>

3819

<insert>DomDocument->create_entity_reference(string content);</insert>

3820

<dialog title="Insert DomDocument->create_entity_reference">DomDocument->create_entity_reference(%0);</dialog>

3821

3822

</function>

3823

<function name="DomDocument->create_processing_instruction">

3824

<description>Creates new PI node</description>

3825

<param name="content" required="1" vallist="0" default="" type="string">content</param>

3826

<return type="string">string</return>

3827

<insert>DomDocument->create_processing_instruction(string content);</insert>

3828

<dialog title="Insert DomDocument->create_processing_instruction">DomDocument->create_processing_instruction(%0);</dialog>

3829

3830

</function>

3831

<function name="DomDocument->create_text_node">

3832

<description>Create new text node</description>

3833

<param name="content" required="1" vallist="0" default="" type="string">content</param>

3834

<return type="object">object</return>

3835

<insert>DomDocument->create_text_node(string content);</insert>

3836

<dialog title="Insert DomDocument->create_text_node">DomDocument->create_text_node(%0);</dialog>

3837

3838

</function>

3839

<function name="DomDocument->doctype">

3840

3841

Returns the document type

3842

</description>

3843

<return type="object">object</return>

3844

<insert>DomDocument->doctype();</insert>

3845

<dialog title="Insert DomDocument->doctype">DomDocument->doctype();</dialog>

3846

3847

</function>

3848

<function name="DomDocument->document_element">

3849

3850

Returns root element node

3851

</description>

3852

<return type="object">object</return>

3853

<insert>DomDocument->document_element();</insert>

3854

<dialog title="Insert DomDocument->document_element">DomDocument->document_element();</dialog>

3855

3856

</function>

3857

3858

3859

Dumps the internal XML tree back into a file

3860

</description>

3861

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

3862

<param name="compressionmode" required="0" vallist="0" default="" type="bool">compressionmode</param>

3863

<param name="format" required="0" vallist="0" default="" type="bool">format</param>

3864

<return type="string">string</return>

3865

<insert>DomDocument->dump_file(string filename [,bool compressionmode] [,bool format]);</insert>

3866

<dialog title="Insert DomDocument->dump_file">DomDocument->dump_file(%0, %1, %2);</dialog>

3867

3868

</function>

3869

3870

3871

Dumps the internal XML tree back into a string

3872

</description>

3873

<param name="format" required="0" vallist="0" default="" type="bool">format</param>

3874

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

3875

<return type="string">string</return>

3876

<insert>DomDocument->dump_mem([bool format] [,string encoding]);</insert>

3877

<dialog title="Insert DomDocument->dump_mem">DomDocument->dump_mem(%0, %1);</dialog>

3878

3879

</function>

3880

<function name="DomDocument->get_element_by_id">

3881

3882

Searches for an element with a certain id

3883

</description>

3884

3885

<return type="object">object</return>

3886

<insert>DomDocument->get_element_by_id(string id);</insert>

3887

<dialog title="Insert DomDocument->get_element_by_id">DomDocument->get_element_by_id(%0);</dialog>

3888

3889

</function>

3890

<function name="DomDocument->get_elements_by_tagname">

3891

3892

</description>

3893

3894

<return type="array">array</return>

3895

<insert>DomDocument->get_elements_by_tagname(string name);</insert>

3896

<dialog title="Insert DomDocument->get_elements_by_tagname">DomDocument->get_elements_by_tagname(%0);</dialog>

3897

3898

</function>

3899

3900

3901

Dumps the internal XML tree back into a string as HTML

3902

</description>

3903

<return type="string">string</return>

3904

<insert>DomDocument->html_dump_mem();</insert>

3905

<dialog title="Insert DomDocument->html_dump_mem">DomDocument->html_dump_mem();</dialog>

3906

3907

</function>

3908

<function name="DomDocument->xinclude">

3909

3910

Substitutes XIncludes in a DomDocument Object.

3911

</description>

3912

3913

<insert>DomDocument->xinclude();</insert>

3914

<dialog title="Insert DomDocument->xinclude">DomDocument->xinclude();</dialog>

3915

3916

</function>

3917

<function name="DomDocumentType->entities">

3918

3919

Returns list of entities

3920

</description>

3921

<return type="array">array</return>

3922

<insert>DomDocumentType->entities();</insert>

3923

<dialog title="Insert DomDocumentType->entities">DomDocumentType->entities();</dialog>

3924

3925

</function>

3926

<function name="DomDocumentType->internal_subset">

3927

3928

Returns internal subset

3929

</description>

3930

3931

<insert>DomDocumentType->internal_subset();</insert>

3932

<dialog title="Insert DomDocumentType->internal_subset">DomDocumentType->internal_subset();</dialog>

3933

3934

</function>

3935

3936

3937

Returns name of document type

3938

</description>

3939

<return type="string">string</return>

3940

<insert>DomDocumentType->name();</insert>

3941

<dialog title="Insert DomDocumentType->name">DomDocumentType->name();</dialog>

3942

3943

</function>

3944

<function name="DomDocumentType->notations">

3945

3946

Returns list of notations

3947

</description>

3948

<return type="array">array</return>

3949

<insert>DomDocumentType->notations();</insert>

3950

<dialog title="Insert DomDocumentType->notations">DomDocumentType->notations();</dialog>

3951

3952

</function>

3953

<function name="DomDocumentType->public_id">

3954

3955

Returns public id of document type

3956

</description>

3957

<return type="string">string</return>

3958

<insert>DomDocumentType->public_id();</insert>

3959

<dialog title="Insert DomDocumentType->public_id">DomDocumentType->public_id();</dialog>

3960

3961

</function>

3962

<function name="DomDocumentType->system_id">

3963

3964

Returns system id of document type

3965

</description>

3966

<return type="string">string</return>

3967

<insert>DomDocumentType->system_id();</insert>

3968

<dialog title="Insert DomDocumentType->system_id">DomDocumentType->system_id();</dialog>

3969

3970

</function>

3971

<function name="DomElement->get_attribute_node">

3972

3973

Returns value of attribute

3974

</description>

3975

3976

<return type="object">object</return>

3977

<insert>DomElement->get_attribute_node(object attr);</insert>

3978

<dialog title="Insert DomElement->get_attribute_node">DomElement->get_attribute_node(%0);</dialog>

3979

3980

</function>

3981

<function name="DomElement->get_attribute">

3982

3983

Returns value of attribute

3984

</description>

3985

3986

<return type="object">object</return>

3987

<insert>DomElement->get_attribute(string name);</insert>

3988

<dialog title="Insert DomElement->get_attribute">DomElement->get_attribute(%0);</dialog>

3989

3990

</function>

3991

<function name="DomElement->get_elements_by_tagname">

3992

3993

Gets elements by tagname

3994

</description>

3995

3996

3997

<insert>DomElement->get_elements_by_tagname(string name);</insert>

3998

<dialog title="Insert DomElement->get_elements_by_tagname">DomElement->get_elements_by_tagname(%0);</dialog>

3999

4000

</function>

4001

<function name="DomElement->has_attribute">

4002

4003

Checks to see if attribute exists

4004

</description>

4005

4006

4007

<insert>DomElement->has_attribute(string name);</insert>

4008

<dialog title="Insert DomElement->has_attribute">DomElement->has_attribute(%0);</dialog>

4009

4010

</function>

4011

<function name="DomElement->remove_attribute">

4012

4013

Removes attribute

4014

</description>

4015

4016

4017

<insert>DomElement->remove_attribute(string name);</insert>

4018

<dialog title="Insert DomElement->remove_attribute">DomElement->remove_attribute(%0);</dialog>

4019

4020

</function>

4021

<function name="DomElement->set_attribute">

4022

4023

Adds new attribute

4024

</description>

4025

4026

<param name="value" required="1" vallist="0" default="" type="string">value</param>

4027

4028

<insert>DomElement->set_attribute(string name, string value);</insert>

4029

<dialog title="Insert DomElement->set_attribute">DomElement->set_attribute(%0, %1);</dialog>

4030

4031

</function>

4032

<function name="DomElement->tagname">

4033

4034

Returns name of element

4035

</description>

4036

<return type="string">string</return>

4037

<insert>DomElement->tagname();</insert>

4038

<dialog title="Insert DomElement->tagname">DomElement->tagname();</dialog>

4039

4040

</function>

4041

<function name="DomNode->add_namespace">

4042

4043

Adds a namespace declaration to a node.

4044

</description>

4045

4046

<param name="prefix" required="1" vallist="0" default="" type="string">prefix</param>

4047

4048

<insert>DomNode->add_namespace(string uri, string prefix);</insert>

4049

<dialog title="Insert DomNode->add_namespace">DomNode->add_namespace(%0, %1);</dialog>

4050

4051

</function>

4052

<function name="DomNode->append_child">

4053

4054

Adds new child at the end of the children

4055

</description>

4056

<param name="newnode" required="1" vallist="0" default="" type="object">newnode</param>

4057

<return type="object">object</return>

4058

<insert>DomNode->append_child(object newnode);</insert>

4059

<dialog title="Insert DomNode->append_child">DomNode->append_child(%0);</dialog>

4060

4061

</function>

4062

<function name="DomNode->append_sibling">

4063

4064

Adds new sibling to a node

4065

</description>

4066

<param name="newnode" required="1" vallist="0" default="" type="object">newnode</param>

4067

<return type="object">object</return>

4068

<insert>DomNode->append_sibling(object newnode);</insert>

4069

<dialog title="Insert DomNode->append_sibling">DomNode->append_sibling(%0);</dialog>

4070

4071

</function>

4072

<function name="DomNode->attributes">

4073

4074

Returns list of attributes

4075

</description>

4076

<return type="array">array</return>

4077

<insert>DomNode->attributes();</insert>

4078

<dialog title="Insert DomNode->attributes">DomNode->attributes();</dialog>

4079

4080

</function>

4081

<function name="DomNode->child_nodes">

4082

4083

Returns children of node

4084

</description>

4085

<return type="array">array</return>

4086

<insert>DomNode->child_nodes();</insert>

4087

<dialog title="Insert DomNode->child_nodes">DomNode->child_nodes();</dialog>

4088

4089

</function>

4090

<function name="DomNode->clone_node">

4091

4092

Clones a node

4093

</description>

4094

<return type="object">object</return>

4095

<insert>DomNode->clone_node();</insert>

4096

<dialog title="Insert DomNode->clone_node">DomNode->clone_node();</dialog>

4097

4098

</function>

4099

4100

4101

Dumps a single node

4102

</description>

4103

<return type="string">string</return>

4104

<insert>DomNode->dump_node();</insert>

4105

<dialog title="Insert DomNode->dump_node">DomNode->dump_node();</dialog>

4106

4107

</function>

4108

<function name="DomNode->first_child">

4109

4110

Returns first child of node

4111

</description>

4112

4113

<insert>DomNode->first_child();</insert>

4114

<dialog title="Insert DomNode->first_child">DomNode->first_child();</dialog>

4115

4116

</function>

4117

<function name="DomNode->get_content">

4118

4119

Gets content of node

4120

</description>

4121

<return type="string">string</return>

4122

<insert>DomNode->get_content();</insert>

4123

<dialog title="Insert DomNode->get_content">DomNode->get_content();</dialog>

4124

4125

</function>

4126

<function name="DomNode->has_attributess">

4127

4128

Checks if node has attributes

4129

</description>

4130

4131

<insert>DomNode->has_attributess();</insert>

4132

<dialog title="Insert DomNode->has_attributess">DomNode->has_attributess();</dialog>

4133

4134

</function>

4135

<function name="DomNode->has_child_nodes">

4136

4137

Checks if node has children

4138

</description>

4139

4140

<insert>DomNode->has_child_nodes();</insert>

4141

<dialog title="Insert DomNode->has_child_nodes">DomNode->has_child_nodes();</dialog>

4142

4143

</function>

4144

<function name="DomNode->insert_before">

4145

4146

Inserts new node as child

4147

</description>

4148

<param name="newnode" required="1" vallist="0" default="" type="object">newnode</param>

4149

<param name="refnode" required="1" vallist="0" default="" type="object">refnode</param>

4150

<return type="object">object</return>

4151

<insert>DomNode->insert_before(object newnode, object refnode);</insert>

4152

<dialog title="Insert DomNode->insert_before">DomNode->insert_before(%0, %1);</dialog>

4153

4154

</function>

4155

<function name="DomNode->is_blank_node">

4156

4157

Checks if node is blank

4158

</description>

4159

4160

<insert>DomNode->is_blank_node();</insert>

4161

<dialog title="Insert DomNode->is_blank_node">DomNode->is_blank_node();</dialog>

4162

4163

</function>

4164

<function name="DomNode->last_child">

4165

4166

Returns last child of node

4167

</description>

4168

<return type="object">object</return>

4169

<insert>DomNode->last_child();</insert>

4170

<dialog title="Insert DomNode->last_child">DomNode->last_child();</dialog>

4171

4172

</function>

4173

<function name="DomNode->next_sibling">

4174

4175

Returns the next sibling of node

4176

</description>

4177

<return type="object">object</return>

4178

<insert>DomNode->next_sibling();</insert>

4179

<dialog title="Insert DomNode->next_sibling">DomNode->next_sibling();</dialog>

4180

4181

</function>

4182

4183

4184

Returns name of node

4185

</description>

4186

<return type="string">string</return>

4187

<insert>DomNode->node_name();</insert>

4188

<dialog title="Insert DomNode->node_name">DomNode->node_name();</dialog>

4189

4190

</function>

4191

4192

4193

Returns type of node

4194

</description>

4195

4196

<insert>DomNode->node_type();</insert>

4197

<dialog title="Insert DomNode->node_type">DomNode->node_type();</dialog>

4198

4199

</function>

4200

<function name="DomNode->node_value">

4201

4202

Returns value of a node

4203

</description>

4204

<return type="string">string</return>

4205

<insert>DomNode->node_value();</insert>

4206

<dialog title="Insert DomNode->node_value">DomNode->node_value();</dialog>

4207

4208

</function>

4209

<function name="DomNode->owner_document">

4210

4211

Returns the document this node belongs to

4212

</description>

4213

<return type="object">object</return>

4214

<insert>DomNode->owner_document();</insert>

4215

<dialog title="Insert DomNode->owner_document">DomNode->owner_document();</dialog>

4216

4217

</function>

4218

<function name="DomNode->parent_node">

4219

4220

Returns the parent of the node

4221

</description>

4222

<return type="object">object</return>

4223

<insert>DomNode->parent_node();</insert>

4224

<dialog title="Insert DomNode->parent_node">DomNode->parent_node();</dialog>

4225

4226

</function>

4227

<function name="DomNode->prefix">

4228

4229

Returns name space prefix of node

4230

</description>

4231

<return type="string">string</return>

4232

<insert>DomNode->prefix();</insert>

4233

<dialog title="Insert DomNode->prefix">DomNode->prefix();</dialog>

4234

4235

</function>

4236

<function name="DomNode->previous_sibling">

4237

4238

Returns the previous sibling of node

4239

</description>

4240

<return type="object">object</return>

4241

<insert>DomNode->previous_sibling();</insert>

4242

<dialog title="Insert DomNode->previous_sibling">DomNode->previous_sibling();</dialog>

4243

4244

</function>

4245

<function name="DomNode->remove_child">

4246

4247

Removes child from list of children

4248

</description>

4249

<param name="oldchild" required="1" vallist="0" default="" type="object">oldchild</param>

4250

<return type="object">object</return>

4251

<insert>DomNode->remove_child(object oldchild);</insert>

4252

<dialog title="Insert DomNode->remove_child">DomNode->remove_child(%0);</dialog>

4253

4254

</function>

4255

<function name="DomNode->replace_child">

4256

4257

Replaces a child

4258

</description>

4259

<param name="oldnode" required="1" vallist="0" default="" type="object">oldnode</param>

4260

<param name="newnode" required="1" vallist="0" default="" type="object">newnode</param>

4261

<return type="object">object</return>

4262

<insert>DomNode->replace_child(object oldnode, object newnode);</insert>

4263

<dialog title="Insert DomNode->replace_child">DomNode->replace_child(%0, %1);</dialog>

4264

4265

</function>

4266

<function name="DomNode->replace_node">

4267

4268

Replaces node

4269

</description>

4270

<param name="newnode" required="1" vallist="0" default="" type="object">newnode</param>

4271

<return type="object">object</return>

4272

<insert>DomNode->replace_node(object newnode);</insert>

4273

<dialog title="Insert DomNode->replace_node">DomNode->replace_node(%0);</dialog>

4274

4275

</function>

4276

<function name="DomNode->set_content">

4277

4278

Sets content of node

4279

</description>

4280

4281

<insert>DomNode->set_content();</insert>

4282

<dialog title="Insert DomNode->set_content">DomNode->set_content();</dialog>

4283

4284

</function>

4285

4286

4287

Sets name of node

4288

</description>

4289

4290

<insert>DomNode->set_name();</insert>

4291

<dialog title="Insert DomNode->set_name">DomNode->set_name();</dialog>

4292

4293

</function>

4294

<function name="DomNode->set_namespace">

4295

4296

Sets namespace of a node.

4297

</description>

4298

4299

<param name="prefix" required="0" vallist="0" default="" type="string">prefix</param>

4300

4301

<insert>DomNode->set_namespace(string uri [,string prefix]);</insert>

4302

<dialog title="Insert DomNode->set_namespace">DomNode->set_namespace(%0, %1);</dialog>

4303

4304

</function>

4305

<function name="DomNode->unlink_node">

4306

4307

Deletes node

4308

</description>

4309

<return type="object">object</return>

4310

<insert>DomNode->unlink_node();</insert>

4311

<dialog title="Insert DomNode->unlink_node">DomNode->unlink_node();</dialog>

4312

4313

</function>

4314

4315

4316

Returns data of pi node

4317

</description>

4318

<return type="string">string</return>

4319

<insert>DomProcessingInstruction->data();</insert>

4320

<dialog title="Insert DomProcessingInstruction->data">DomProcessingInstruction->data();</dialog>

4321

4322

</function>

4323

<function name="DomProcessingInstruction->target">

4324

4325

Returns target of pi node

4326

</description>

4327

<return type="string">string</return>

4328

<insert>DomProcessingInstruction->target();</insert>

4329

<dialog title="Insert DomProcessingInstruction->target">DomProcessingInstruction->target();</dialog>

4330

4331

</function>

4332

<function name="DomXsltStylesheet->process">

4333

4334

Applies the XSLT-Transformation on a DomDocument Object.

4335

</description>

4336

<param name="DomDocument" required="1" vallist="0" default="" type="object">DomDocument</param>

4337

<param name="xslt_parameters" required="0" vallist="0" default="" type="array">xslt_parameters</param>

4338

<param name="param_is_xpath" required="0" vallist="0" default="" type="bool">param_is_xpath</param>

4339

<return type="object">object</return>

4340

<insert>DomXsltStylesheet->process(object DomDocument [,array xslt_parameters] [,bool param_is_xpath]);</insert>

4341

<dialog title="Insert DomXsltStylesheet->process">DomXsltStylesheet->process(%0, %1, %2);</dialog>

4342

4343

</function>

4344

<function name="DomXsltStylesheet->result_dump_file">

4345

4346

Dumps the result from a XSLT-Transformation into a file

4347

</description>

4348

<param name="DomDocument" required="1" vallist="0" default="" type="object">DomDocument</param>

4349

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

4350

<return type="string">string</return>

4351

<insert>DomXsltStylesheet->result_dump_file(object DomDocument, string filename);</insert>

4352

<dialog title="Insert DomXsltStylesheet->result_dump_file">DomXsltStylesheet->result_dump_file(%0, %1);</dialog>

4353

4354

</function>

4355

<function name="DomXsltStylesheet->result_dump_mem">

4356

4357

Dumps the result from a XSLT-Transformation back into a string

4358

</description>

4359

<param name="DomDocument" required="1" vallist="0" default="" type="object">DomDocument</param>

4360

<return type="string">string</return>

4361

<insert>DomXsltStylesheet->result_dump_mem(object DomDocument);</insert>

4362

<dialog title="Insert DomXsltStylesheet->result_dump_mem">DomXsltStylesheet->result_dump_mem(%0);</dialog>

4363

4364

</function>

4365

4366

4367

Creates new empty XML document

4368

</description>

4369

<param name="version" required="1" vallist="0" default="" type="string">version</param>

4370

<return type="object">object</return>

4371

<insert>domxml_new_doc(string version);</insert>

4372

<dialog title="Insert domxml_new_doc">domxml_new_doc(%0);</dialog>

4373

4374

</function>

4375

4376

<description>Creates a DOM object from XML file</description>

4377

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

4378

<return type="object">object</return>

4379

<insert>domxml_open_file(string filename);</insert>

4380

<dialog title="Insert domxml_open_file">domxml_open_file(%0);</dialog>

4381

4382

</function>

4383

4384

<description>Creates a DOM object of an XML document</description>

4385

4386

<return type="object">object</return>

4387

<insert>domxml_open_mem(string str);</insert>

4388

<dialog title="Insert domxml_open_mem">domxml_open_mem(%0);</dialog>

4389

4390

</function>

4391

4392

4393

Get XML library version

4394

</description>

4395

<return type="string">string</return>

4396

<insert>domxml_version();</insert>

4397

<dialog title="Insert domxml_version">domxml_version();</dialog>

4398

4399

</function>

4400

4401

4402

Creates a tree of PHP objects from an XML document

4403

</description>

4404

4405

<return type="object">object</return>

4406

<insert>domxml_xmltree(string str);</insert>

4407

<dialog title="Insert domxml_xmltree">domxml_xmltree(%0);</dialog>

4408

4409

</function>

4410

4411

4412

Creates a DomXsltStylesheet Object from a DomDocument Object.

4413

</description>

4414

<param name="DocDocument Object" required="1" vallist="0" default="" type="object">DocDocument Object</param>

4415

<return type="object">object</return>

4416

<insert>domxml_xslt_stylesheet_doc(object DocDocument Object);</insert>

4417

<dialog title="Insert domxml_xslt_stylesheet_doc">domxml_xslt_stylesheet_doc(%0);</dialog>

4418

4419

</function>

4420

4421

4422

Creates a DomXsltStylesheet Object from a xsl document in a file.

4423

</description>

4424

4425

<return type="object">object</return>

4426

<insert>domxml_xslt_stylesheet_file(string xsl file);</insert>

4427

<dialog title="Insert domxml_xslt_stylesheet_file">domxml_xslt_stylesheet_file(%0);</dialog>

4428

4429

</function>

4430

4431

4432

Creates a DomXsltStylesheet Object from a xml document in a string.

4433

</description>

4434

<param name="xsl document" required="1" vallist="0" default="" type="string">xsl document</param>

4435

<return type="object">object</return>

4436

<insert>domxml_xslt_stylesheet(string xsl document);</insert>

4437

<dialog title="Insert domxml_xslt_stylesheet">domxml_xslt_stylesheet(%0);</dialog>

4438

4439

</function>

4440

4441

4442

Evaluates the XPath Location Path in the given string

4443

</description>

4444

<param name="xpath_context" required="1" vallist="0" default="" type="object">xpath_context</param>

4445

<return type="array">array</return>

4446

<insert>xpath_eval_expression(object xpath_context);</insert>

4447

<dialog title="Insert xpath_eval_expression">xpath_eval_expression(%0);</dialog>

4448

4449

</function>

4450

4451

4452

Evaluates the XPath Location Path in the given string

4453

</description>

4454

<param name="xpath context" required="1" vallist="0" default="" type="object">xpath context</param>

4455

<param name="xpath expression" required="1" vallist="0" default="" type="string">xpath expression</param>

4456

<param name="contextnode" required="0" vallist="0" default="" type="object">contextnode</param>

4457

<return type="array">array</return>

4458

<insert>xpath_eval(object xpath context, string xpath expression [,object contextnode]);</insert>

4459

<dialog title="Insert xpath_eval">xpath_eval(%0, %1, %2);</dialog>

4460

4461

</function>

4462

4463

4464

Creates new xpath context

4465

</description>

4466

<param name="dom document" required="1" vallist="0" default="" type="object">dom document</param>

4467

<return type="object">object</return>

4468

<insert>xpath_new_context(object dom document);</insert>

4469

<dialog title="Insert xpath_new_context">xpath_new_context(%0);</dialog>

4470

4471

</function>

4472

4473

4474

Evaluate the XPtr Location Path in the given string

4475

</description>

4476

<param name="xpath_context" required="0" vallist="0" default="" type="object">xpath_context</param>

4477

4478

4479

<insert>xptr_eval([object xpath_context], string eval_str);</insert>

4480

4481

4482

</function>

4483

4484

4485

Create new XPath Context

4486

</description>

4487

<param name="doc_handle" required="0" vallist="0" default="" type="object">doc_handle</param>

4488

<return type="string">string</return>

4489

<insert>xptr_new_context([object doc_handle]);</insert>

4490

<dialog title="Insert xptr_new_context">xptr_new_context(%0);</dialog>

4491

4492

</function>

4493

</group>

4494

4495

4496

<description>Loads a DOTNET module</description>

4497

<param name="assembly_name" required="1" vallist="0" default="" type="string">assembly_name</param>

4498

<param name="datatype_name" required="0" vallist="0" default="" type="string">datatype_name</param>

4499

<param name="codepage" required="0" vallist="0" default="" type="int">codepage</param>

4500

4501

<insert>dotnet_load(string assembly_name [,string datatype_name] [,int codepage]);</insert>

4502

<dialog title="Insert dotnet_load">dotnet_load(%0, %1, %2);</dialog>

4503

4504

</function>

4505

</group>

4506

4507

4508

4509

Generates a backtrace

4510

</description>

4511

<return type="array">array</return>

4512

<insert>debug_backtrace();</insert>

4513

<dialog title="Insert debug_backtrace">debug_backtrace();</dialog>

4514

4515

</function>

4516

4517

<description>send an error message somewhere</description>

4518

<param name="message" required="1" vallist="0" default="" type="string">message</param>

4519

<param name="message_type" required="0" vallist="0" default="" type="int">message_type</param>

4520

<param name="destination" required="0" vallist="0" default="" type="string">destination</param>

4521

<param name="extra_headers" required="0" vallist="0" default="" type="string">extra_headers</param>

4522

4523

<insert>error_log(string message [,int message_type] [,string destination] [,string extra_headers]);</insert>

4524

<dialog title="Insert error_log">error_log(%0, %1, %2, %3);</dialog>

4525

4526

</function>

4527

4528

<description>set which PHP errors are reported</description>

4529

<param name="level" required="0" vallist="0" default="" type="int">level</param>

4530

4531

<insert>error_reporting([int level]);</insert>

4532

<dialog title="Insert error_reporting">error_reporting(%0);</dialog>

4533

4534

</function>

4535

4536

4537

Restores the previous error handler function

4538

</description>

4539

4540

<insert>restore_error_handler();</insert>

4541

<dialog title="Insert restore_error_handler">restore_error_handler();</dialog>

4542

4543

</function>

4544

4545

4546

Sets a user-defined error handler function.

4547

</description>

4548

<param name="error_handler" required="1" vallist="0" default="" type="callback">error_handler</param>

4549

<return type="string">string</return>

4550

<insert>set_error_handler(callback error_handler);</insert>

4551

<dialog title="Insert set_error_handler">set_error_handler(%0);</dialog>

4552

4553

</function>

4554

4555

4556

Generates a user-level error/warning/notice message

4557

</description>

4558

<param name="error_msg" required="1" vallist="0" default="" type="string">error_msg</param>

4559

<param name="error_type" required="0" vallist="0" default="" type="int">error_type</param>

4560

4561

<insert>trigger_error(string error_msg [,int error_type]);</insert>

4562

<dialog title="Insert trigger_error">trigger_error(%0, %1);</dialog>

4563

4564

</function>

4565

</group>

4566

4567

4568

<description>escape a string to be used as a shell argument</description>

4569

4570

<return type="string">string</return>

4571

<insert>escapeshellarg(string arg);</insert>

4572

<dialog title="Insert escapeshellarg">escapeshellarg(%0);</dialog>

4573

4574

</function>

4575

4576

<description>escape shell metacharacters</description>

4577

<param name="command" required="1" vallist="0" default="" type="string">command</param>

4578

<return type="string">string</return>

4579

<insert>escapeshellcmd(string command);</insert>

4580

<dialog title="Insert escapeshellcmd">escapeshellcmd(%0);</dialog>

4581

4582

</function>

4583

4584

<description>Execute an external program</description>

4585

<param name="command" required="1" vallist="0" default="" type="string">command</param>

4586

<param name="output

4587

" required="0" vallist="0" default="" type="array">output

4588

</param>

4589

<param name="return_var" required="0" vallist="0" default="" type="int">return_var</param>

4590

<return type="string">string</return>

4591

<insert>exec(string command [,array output

4592

] [,int return_var]);</insert>

4593

4594

4595

</function>

4596

4597

4598

Execute an external program and display raw output

4599

</description>

4600

<param name="command" required="1" vallist="0" default="" type="string">command</param>

4601

<param name="return_var" required="0" vallist="0" default="" type="int">return_var</param>

4602

4603

<insert>passthru(string command [,int return_var]);</insert>

4604

<dialog title="Insert passthru">passthru(%0, %1);</dialog>

4605

4606

</function>

4607

4608

4609

Close a process opened by proc_open and return the exit code of that

4610

process.

4611

</description>

4612

<param name="process" required="1" vallist="0" default="" type="resource">process</param>

4613

4614

<insert>proc_close(resource process);</insert>

4615

<dialog title="Insert proc_close">proc_close(%0);</dialog>

4616

4617

</function>

4618

4619

4620

Get information about a process opened by </description>

4621

<param name="process" required="1" vallist="0" default="" type="resource">process</param>

4622

4623

<insert>proc_get_status(resource process);</insert>

4624

<dialog title="Insert proc_get_status">proc_get_status(%0);</dialog>

4625

4626

</function>

4627

4628

4629

Execute a command and open file pointers for input/output

4630

</description>

4631

4632

<param name="descriptorspec" required="1" vallist="0" default="" type="array">descriptorspec</param>

4633

<param name="pipes" required="1" vallist="0" default="" type="array">pipes</param>

4634

<return type="resource">resource</return>

4635

<insert>proc_open(string cmd, array descriptorspec, array pipes);</insert>

4636

4637

4638

</function>

4639

4640

4641

Execute command via shell and return complete output as string

4642

</description>

4643

4644

<return type="string">string</return>

4645

<insert>shell_exec(string cmd);</insert>

4646

<dialog title="Insert shell_exec">shell_exec(%0);</dialog>

4647

4648

</function>

4649

4650

<description>Execute an external program and display output</description>

4651

<param name="command" required="1" vallist="0" default="" type="string">command</param>

4652

<param name="return_var" required="0" vallist="0" default="" type="int">return_var</param>

4653

<return type="string">string</return>

4654

<insert>system(string command [,int return_var]);</insert>

4655

<dialog title="Insert system">system(%0, %1);</dialog>

4656

4657

</function>

4658

</group>

4659

4660

4661

4662

Get number of affected rows in previous FrontBase operation

4663

</description>

4664

<param name="

4665

link_identifier

4666

" required="0" vallist="0" default="" type="resource">

4667

link_identifier

4668

</param>

4669

4670

<insert>fbsql_affected_rows([resource

4671

link_identifier

4672

]);</insert>

4673

<dialog title="Insert fbsql_affected_rows">fbsql_affected_rows(%0);</dialog>

4674

4675

</function>

4676

4677

<description>Enable or disable autocommit</description>

4678

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

4679

<param name="OnOff" required="0" vallist="0" default="" type="bool">OnOff</param>

4680

4681

<insert>fbsql_autocommit(resource link_identifier [,bool OnOff]);</insert>

4682

<dialog title="Insert fbsql_autocommit">fbsql_autocommit(%0, %1);</dialog>

4683

4684

</function>

4685

4686

4687

Change logged in user of the active connection

4688

</description>

4689

4690

<param name="password" required="1" vallist="0" default="" type="string">password</param>

4691

<param name="

4692

database

4693

" required="0" vallist="0" default="" type="string">

4694

database

4695

</param>

4696

<param name="

4697

link_identifier

4698

" required="0" vallist="0" default="" type="resource">

4699

link_identifier

4700

</param>

4701

<return type="resource">resource</return>

4702

<insert>fbsql_change_user(string user, string password [,string

4703

database

4704

] [,resource

4705

link_identifier

4706

]);</insert>

4707

<dialog title="Insert fbsql_change_user">fbsql_change_user(%0, %1, %2, %3);</dialog>

4708

4709

</function>

4710

4711

<description>Close FrontBase connection</description>

4712

<param name="

4713

link_identifier

4714

" required="0" vallist="0" default="" type="resource">

4715

link_identifier

4716

</param>

4717

4718

<insert>fbsql_close([resource

4719

link_identifier

4720

]);</insert>

4721

<dialog title="Insert fbsql_close">fbsql_close(%0);</dialog>

4722

4723

</function>

4724

4725

<description>Commits a transaction to the database</description>

4726

<param name="

4727

link_identifier

4728

" required="0" vallist="0" default="" type="resource">

4729

link_identifier

4730

</param>

4731

4732

<insert>fbsql_commit([resource

4733

link_identifier

4734

]);</insert>

4735

<dialog title="Insert fbsql_commit">fbsql_commit(%0);</dialog>

4736

4737

</function>

4738

4739

<description>Open a connection to a FrontBase Server</description>

4740

<param name="hostname" required="0" vallist="0" default="" type="string">hostname</param>

4741

<param name="username" required="0" vallist="0" default="" type="string">username</param>

4742

<param name="password" required="0" vallist="0" default="" type="string">password</param>

4743

<return type="resource">resource</return>

4744

<insert>fbsql_connect([string hostname] [,string username] [,string password]);</insert>

4745

<dialog title="Insert fbsql_connect">fbsql_connect(%0, %1, %2);</dialog>

4746

4747

</function>

4748

4749

<description>Create a BLOB</description>

4750

4751

<param name="

4752

link_identifier

4753

" required="0" vallist="0" default="" type="resource">

4754

link_identifier

4755

</param>

4756

<return type="string">string</return>

4757

<insert>fbsql_create_blob(string blob_data [,resource

4758

link_identifier

4759

]);</insert>

4760

<dialog title="Insert fbsql_create_blob">fbsql_create_blob(%0, %1);</dialog>

4761

4762

</function>

4763

4764

<description>Create a CLOB</description>

4765

4766

<param name="

4767

link_identifier

4768

" required="0" vallist="0" default="" type="resource">

4769

link_identifier

4770

</param>

4771

<return type="string">string</return>

4772

<insert>fbsql_create_clob(string clob_data [,resource

4773

link_identifier

4774

]);</insert>

4775

<dialog title="Insert fbsql_create_clob">fbsql_create_clob(%0, %1);</dialog>

4776

4777

</function>

4778

4779

<description>Create a FrontBase database</description>

4780

<param name="database name" required="1" vallist="0" default="" type="string">database name</param>

4781

<param name="

4782

link_identifier

4783

" required="0" vallist="0" default="" type="resource">

4784

link_identifier

4785

</param>

4786

4787

<insert>fbsql_create_db(string database name [,resource

4788

link_identifier

4789

]);</insert>

4790

<dialog title="Insert fbsql_create_db">fbsql_create_db(%0, %1);</dialog>

4791

4792

</function>

4793

4794

<description>Move internal result pointer</description>

4795

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

4796

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

4797

4798

<insert>fbsql_data_seek(resource result_identifier, int row_number);</insert>

4799

<dialog title="Insert fbsql_data_seek">fbsql_data_seek(%0, %1);</dialog>

4800

4801

</function>

4802

4803

4804

Sets or retrieves the password for a FrontBase database

4805

</description>

4806

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

4807

<param name="

4808

database_password

4809

" required="0" vallist="0" default="" type="string">

4810

database_password

4811

</param>

4812

<return type="string">string</return>

4813

<insert>fbsql_database_password(resource link_identifier [,string

4814

database_password

4815

]);</insert>

4816

<dialog title="Insert fbsql_database_password">fbsql_database_password(%0, %1);</dialog>

4817

4818

</function>

4819

4820

<description>Get or set the database name used with a connection</description>

4821

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

4822

<param name="database" required="0" vallist="0" default="" type="string">database</param>

4823

<return type="string">string</return>

4824

<insert>fbsql_database(resource link_identifier [,string database]);</insert>

4825

<dialog title="Insert fbsql_database">fbsql_database(%0, %1);</dialog>

4826

4827

</function>

4828

4829

<description>Send a FrontBase query</description>

4830

<param name="database" required="1" vallist="0" default="" type="string">database</param>

4831

<param name="query" required="1" vallist="0" default="" type="string">query</param>

4832

<param name="

4833

link_identifier

4834

" required="0" vallist="0" default="" type="resource">

4835

link_identifier

4836

</param>

4837

<return type="resource">resource</return>

4838

<insert>fbsql_db_query(string database, string query [,resource

4839

link_identifier

4840

]);</insert>

4841

<dialog title="Insert fbsql_db_query">fbsql_db_query(%0, %1, %2);</dialog>

4842

4843

</function>

4844

4845

<description>Get the status for a given database</description>

4846

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

4847

<param name="

4848

link_identifier

4849

" required="0" vallist="0" default="" type="resource">

4850

link_identifier

4851

</param>

4852

4853

<insert>fbsql_db_status(string database_name [,resource

4854

link_identifier

4855

]);</insert>

4856

<dialog title="Insert fbsql_db_status">fbsql_db_status(%0, %1);</dialog>

4857

4858

</function>

4859

4860

<description>Drop (delete) a FrontBase database</description>

4861

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

4862

<param name="

4863

link_identifier

4864

" required="0" vallist="0" default="" type="resource">

4865

link_identifier

4866

</param>

4867

4868

<insert>fbsql_drop_db(string database_name [,resource

4869

link_identifier

4870

]);</insert>

4871

<dialog title="Insert fbsql_drop_db">fbsql_drop_db(%0, %1);</dialog>

4872

4873

</function>

4874

4875

4876

Returns the numerical value of the error message from previous

4877

FrontBase operation

4878

</description>

4879

<param name="

4880

link_identifier

4881

" required="0" vallist="0" default="" type="resource">

4882

link_identifier

4883

</param>

4884

4885

<insert>fbsql_errno([resource

4886

link_identifier

4887

]);</insert>

4888

<dialog title="Insert fbsql_errno">fbsql_errno(%0);</dialog>

4889

4890

</function>

4891

4892

4893

Returns the text of the error message from previous FrontBase

4894

operation

4895

</description>

4896

<param name="

4897

link_identifier

4898

" required="0" vallist="0" default="" type="resource">

4899

link_identifier

4900

</param>

4901

<return type="string">string</return>

4902

<insert>fbsql_error([resource

4903

link_identifier

4904

]);</insert>

4905

<dialog title="Insert fbsql_error">fbsql_error(%0);</dialog>

4906

4907

</function>

4908

4909

4910

Fetch a result row as an associative array, a numeric array, or

4911

both

4912

</description>

4913

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4914

<param name="

4915

result_type

4916

" required="0" vallist="0" default="" type="int">

4917

result_type

4918

</param>

4919

<return type="array">array</return>

4920

<insert>fbsql_fetch_array(resource result [,int

4921

result_type

4922

]);</insert>

4923

<dialog title="Insert fbsql_fetch_array">fbsql_fetch_array(%0, %1);</dialog>

4924

4925

</function>

4926

4927

4928

Fetch a result row as an associative array

4929

</description>

4930

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4931

<return type="array">array</return>

4932

<insert>fbsql_fetch_assoc(resource result);</insert>

4933

<dialog title="Insert fbsql_fetch_assoc">fbsql_fetch_assoc(%0);</dialog>

4934

4935

</function>

4936

4937

4938

Get column information from a result and return as an object

4939

</description>

4940

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4941

<param name="

4942

field_offset

4943

" required="0" vallist="0" default="" type="int">

4944

field_offset

4945

</param>

4946

<return type="object">object</return>

4947

<insert>fbsql_fetch_field(resource result [,int

4948

field_offset

4949

]);</insert>

4950

<dialog title="Insert fbsql_fetch_field">fbsql_fetch_field(%0, %1);</dialog>

4951

4952

</function>

4953

4954

4955

Get the length of each output in a result

4956

</description>

4957

<param name="result" required="0" vallist="0" default="" type="resource">result</param>

4958

<return type="array">array</return>

4959

<insert>fbsql_fetch_lengths([resource result]);</insert>

4960

<dialog title="Insert fbsql_fetch_lengths">fbsql_fetch_lengths(%0);</dialog>

4961

4962

</function>

4963

4964

<description>Fetch a result row as an object</description>

4965

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4966

<param name="

4967

result_type

4968

" required="0" vallist="0" default="" type="int">

4969

result_type

4970

</param>

4971

<return type="object">object</return>

4972

<insert>fbsql_fetch_object(resource result [,int

4973

result_type

4974

]);</insert>

4975

<dialog title="Insert fbsql_fetch_object">fbsql_fetch_object(%0, %1);</dialog>

4976

4977

</function>

4978

4979

<description>Get a result row as an enumerated array</description>

4980

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4981

<return type="array">array</return>

4982

<insert>fbsql_fetch_row(resource result);</insert>

4983

<dialog title="Insert fbsql_fetch_row">fbsql_fetch_row(%0);</dialog>

4984

4985

</function>

4986

4987

4988

Get the flags associated with the specified field in a result

4989

</description>

4990

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

4991

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

4992

<return type="string">string</return>

4993

<insert>fbsql_field_flags(resource result, int field_offset);</insert>

4994

<dialog title="Insert fbsql_field_flags">fbsql_field_flags(%0, %1);</dialog>

4995

4996

</function>

4997

4998

4999

Returns the length of the specified field

5000

</description>

5001

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5002

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

5003

5004

<insert>fbsql_field_len(resource result, int field_offset);</insert>

5005

<dialog title="Insert fbsql_field_len">fbsql_field_len(%0, %1);</dialog>

5006

5007

</function>

5008

5009

5010

Get the name of the specified field in a result

5011

</description>

5012

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5013

<param name="field_index" required="1" vallist="0" default="" type="int">field_index</param>

5014

<return type="string">string</return>

5015

<insert>fbsql_field_name(resource result, int field_index);</insert>

5016

<dialog title="Insert fbsql_field_name">fbsql_field_name(%0, %1);</dialog>

5017

5018

</function>

5019

5020

5021

Set result pointer to a specified field offset

5022

</description>

5023

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5024

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

5025

5026

<insert>fbsql_field_seek(resource result, int field_offset);</insert>

5027

<dialog title="Insert fbsql_field_seek">fbsql_field_seek(%0, %1);</dialog>

5028

5029

</function>

5030

5031

5032

Get name of the table the specified field is in

5033

</description>

5034

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5035

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

5036

<return type="string">string</return>

5037

<insert>fbsql_field_table(resource result, int field_offset);</insert>

5038

<dialog title="Insert fbsql_field_table">fbsql_field_table(%0, %1);</dialog>

5039

5040

</function>

5041

5042

5043

Get the type of the specified field in a result

5044

</description>

5045

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5046

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

5047

<return type="string">string</return>

5048

<insert>fbsql_field_type(resource result, int field_offset);</insert>

5049

<dialog title="Insert fbsql_field_type">fbsql_field_type(%0, %1);</dialog>

5050

5051

</function>

5052

5053

<description>Free result memory</description>

5054

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5055

5056

<insert>fbsql_free_result(resource result);</insert>

5057

<dialog title="Insert fbsql_free_result">fbsql_free_result(%0);</dialog>

5058

5059

</function>

5060

5061

<description>No description given yet</description>

5062

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

5063

<return type="array">array</return>

5064

<insert>fbsql_get_autostart_info([resource link_identifier]);</insert>

5065

<dialog title="Insert fbsql_get_autostart_info">fbsql_get_autostart_info(%0);</dialog>

5066

5067

</function>

5068

5069

<description>Get or set the host name used with a connection</description>

5070

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

5071

5072

<return type="string">string</return>

5073

<insert>fbsql_hostname(resource link_identifier [,string host_name]);</insert>

5074

<dialog title="Insert fbsql_hostname">fbsql_hostname(%0, %1);</dialog>

5075

5076

</function>

5077

5078

5079

Get the id generated from the previous INSERT operation

5080

</description>

5081

<param name="

5082

link_identifier

5083

" required="0" vallist="0" default="" type="resource">

5084

link_identifier

5085

</param>

5086

5087

<insert>fbsql_insert_id([resource

5088

link_identifier

5089

]);</insert>

5090

<dialog title="Insert fbsql_insert_id">fbsql_insert_id(%0);</dialog>

5091

5092

</function>

5093

5094

5095

List databases available on a FrontBase server

5096

</description>

5097

<param name="

5098

link_identifier

5099

" required="0" vallist="0" default="" type="resource">

5100

link_identifier

5101

</param>

5102

<return type="resource">resource</return>

5103

<insert>fbsql_list_dbs([resource

5104

link_identifier

5105

]);</insert>

5106

<dialog title="Insert fbsql_list_dbs">fbsql_list_dbs(%0);</dialog>

5107

5108

</function>

5109

5110

<description>List FrontBase result fields</description>

5111

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

5112

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

5113

<param name="

5114

link_identifier

5115

" required="0" vallist="0" default="" type="resource">

5116

link_identifier

5117

</param>

5118

<return type="resource">resource</return>

5119

<insert>fbsql_list_fields(string database_name, string table_name [,resource

5120

link_identifier

5121

]);</insert>

5122

<dialog title="Insert fbsql_list_fields">fbsql_list_fields(%0, %1, %2);</dialog>

5123

5124

</function>

5125

5126

<description>List tables in a FrontBase database</description>

5127

<param name="database" required="1" vallist="0" default="" type="string">database</param>

5128

<param name="

5129

link_identifier

5130

" required="0" vallist="0" default="" type="resource">

5131

link_identifier

5132

</param>

5133

<return type="resource">resource</return>

5134

<insert>fbsql_list_tables(string database [,resource

5135

link_identifier

5136

]);</insert>

5137

<dialog title="Insert fbsql_list_tables">fbsql_list_tables(%0, %1);</dialog>

5138

5139

</function>

5140

5141

5142

Move the internal result pointer to the next result

5143

</description>

5144

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

5145

5146

<insert>fbsql_next_result(resource result_id);</insert>

5147

<dialog title="Insert fbsql_next_result">fbsql_next_result(%0);</dialog>

5148

5149

</function>

5150

5151

<description>Get number of fields in result</description>

5152

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5153

5154

<insert>fbsql_num_fields(resource result);</insert>

5155

<dialog title="Insert fbsql_num_fields">fbsql_num_fields(%0);</dialog>

5156

5157

</function>

5158

5159

<description>Get number of rows in result</description>

5160

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5161

5162

<insert>fbsql_num_rows(resource result);</insert>

5163

<dialog title="Insert fbsql_num_rows">fbsql_num_rows(%0);</dialog>

5164

5165

</function>

5166

5167

<description>Get or set the user password used with a connection</description>

5168

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

5169

<param name="password" required="0" vallist="0" default="" type="string">password</param>

5170

<return type="string">string</return>

5171

<insert>fbsql_password(resource link_identifier [,string password]);</insert>

5172

<dialog title="Insert fbsql_password">fbsql_password(%0, %1);</dialog>

5173

5174

</function>

5175

5176

5177

Open a persistent connection to a FrontBase Server

5178

</description>

5179

<param name="hostname" required="0" vallist="0" default="" type="string">hostname</param>

5180

<param name="username" required="0" vallist="0" default="" type="string">username</param>

5181

<param name="password" required="0" vallist="0" default="" type="string">password</param>

5182

<return type="resource">resource</return>

5183

<insert>fbsql_pconnect([string hostname] [,string username] [,string password]);</insert>

5184

<dialog title="Insert fbsql_pconnect">fbsql_pconnect(%0, %1, %2);</dialog>

5185

5186

</function>

5187

5188

<description>Send a FrontBase query</description>

5189

<param name="query" required="1" vallist="0" default="" type="string">query</param>

5190

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

5191

<return type="resource">resource</return>

5192

<insert>fbsql_query(string query [,resource link_identifier]);</insert>

5193

<dialog title="Insert fbsql_query">fbsql_query(%0, %1);</dialog>

5194

5195

</function>

5196

5197

<description>Read a BLOB from the database</description>

5198

<param name="blob_handle" required="1" vallist="0" default="" type="string">blob_handle</param>

5199

<param name="

5200

link_identifier

5201

" required="0" vallist="0" default="" type="resource">

5202

link_identifier

5203

</param>

5204

<return type="string">string</return>

5205

<insert>fbsql_read_blob(string blob_handle [,resource

5206

link_identifier

5207

]);</insert>

5208

<dialog title="Insert fbsql_read_blob">fbsql_read_blob(%0, %1);</dialog>

5209

5210

</function>

5211

5212

<description>Read a CLOB from the database</description>

5213

<param name="clob_handle" required="1" vallist="0" default="" type="string">clob_handle</param>

5214

<param name="

5215

link_identifier

5216

" required="0" vallist="0" default="" type="resource">

5217

link_identifier

5218

</param>

5219

<return type="string">string</return>

5220

<insert>fbsql_read_clob(string clob_handle [,resource

5221

link_identifier

5222

]);</insert>

5223

<dialog title="Insert fbsql_read_clob">fbsql_read_clob(%0, %1);</dialog>

5224

5225

</function>

5226

5227

<description>Get result data</description>

5228

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5229

5230

<param name="

5231

field

5232

" required="0" vallist="0" default="" type="mixed">

5233

field

5234

</param>

5235

<return type="mixed">mixed</return>

5236

<insert>fbsql_result(resource result, int row [,mixed

5237

field

5238

]);</insert>

5239

<dialog title="Insert fbsql_result">fbsql_result(%0, %1, %2);</dialog>

5240

5241

</function>

5242

5243

<description>Rollback a transaction to the database</description>

5244

<param name="

5245

link_identifier

5246

" required="0" vallist="0" default="" type="resource">

5247

link_identifier

5248

</param>

5249

5250

<insert>fbsql_rollback([resource

5251

link_identifier

5252

]);</insert>

5253

<dialog title="Insert fbsql_rollback">fbsql_rollback(%0);</dialog>

5254

5255

</function>

5256

5257

<description>Select a FrontBase database</description>

5258

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

5259

<param name="

5260

link_identifier

5261

" required="0" vallist="0" default="" type="resource">

5262

link_identifier

5263

</param>

5264

5265

<insert>fbsql_select_db(string database_name [,resource

5266

link_identifier

5267

]);</insert>

5268

<dialog title="Insert fbsql_select_db">fbsql_select_db(%0, %1);</dialog>

5269

5270

</function>

5271

5272

5273

Set the LOB retrieve mode for a FrontBase result set

5274

</description>

5275

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5276

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

5277

5278

<insert>fbsql_set_lob_mode(resource result, string database_name);</insert>

5279

<dialog title="Insert fbsql_set_lob_mode">fbsql_set_lob_mode(%0, %1);</dialog>

5280

5281

</function>

5282

5283

5284

Set the transaction locking and isolation

5285

</description>

5286

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

5287

<param name="Locking" required="1" vallist="0" default="" type="int">Locking</param>

5288

<param name="Isolation" required="1" vallist="0" default="" type="int">Isolation</param>

5289

5290

<insert>fbsql_set_transaction(resource link_identifier, int Locking, int Isolation);</insert>

5291

<dialog title="Insert fbsql_set_transaction">fbsql_set_transaction(%0, %1, %2);</dialog>

5292

5293

</function>

5294

5295

<description>Start a database on local or remote server</description>

5296

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

5297

<param name="

5298

link_identifier

5299

" required="0" vallist="0" default="" type="resource">

5300

link_identifier

5301

</param>

5302

5303

<insert>fbsql_start_db(string database_name [,resource

5304

link_identifier

5305

]);</insert>

5306

<dialog title="Insert fbsql_start_db">fbsql_start_db(%0, %1);</dialog>

5307

5308

</function>

5309

5310

<description>Stop a database on local or remote server</description>

5311

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

5312

<param name="

5313

link_identifier

5314

" required="0" vallist="0" default="" type="resource">

5315

link_identifier

5316

</param>

5317

5318

<insert>fbsql_stop_db(string database_name [,resource

5319

link_identifier

5320

]);</insert>

5321

<dialog title="Insert fbsql_stop_db">fbsql_stop_db(%0, %1);</dialog>

5322

5323

</function>

5324

5325

<description>Get table name of field</description>

5326

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

5327

5328

<return type="string">string</return>

5329

<insert>fbsql_tablename(resource result, int i);</insert>

5330

<dialog title="Insert fbsql_tablename">fbsql_tablename(%0, %1);</dialog>

5331

5332

</function>

5333

5334

<description>Get or set the host user used with a connection</description>

5335

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

5336

<param name="username" required="0" vallist="0" default="" type="string">username</param>

5337

<return type="string">string</return>

5338

<insert>fbsql_username(resource link_identifier [,string username]);</insert>

5339

<dialog title="Insert fbsql_username">fbsql_username(%0, %1);</dialog>

5340

5341

</function>

5342

5343

<description>Enable or disable FrontBase warnings</description>

5344

<param name="

5345

OnOff

5346

" required="0" vallist="0" default="" type="bool">

5347

OnOff

5348

</param>

5349

5350

<insert>fbsql_warnings([bool

5351

OnOff

5352

]);</insert>

5353

<dialog title="Insert fbsql_warnings">fbsql_warnings(%0);</dialog>

5354

5355

</function>

5356

</group>

5357

5358

5359

<description>Adds javascript code to the FDF document</description>

5360

<param name="fdfdoc" required="1" vallist="0" default="" type="resource">fdfdoc</param>

5361

<param name="script_name" required="1" vallist="0" default="" type="string">script_name</param>

5362

<param name="script_code" required="1" vallist="0" default="" type="string">script_code</param>

5363

5364

<insert>fdf_add_doc_javascript(resource fdfdoc, string script_name, string script_code);</insert>

5365

<dialog title="Insert fdf_add_doc_javascript">fdf_add_doc_javascript(%0, %1, %2);</dialog>

5366

5367

</function>

5368

5369

<description>Adds a template into the FDF document</description>

5370

<param name="fdfdoc" required="1" vallist="0" default="" type="resource">fdfdoc</param>

5371

<param name="newpage" required="1" vallist="0" default="" type="int">newpage</param>

5372

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5373

<param name="template" required="1" vallist="0" default="" type="string">template</param>

5374

<param name="rename" required="1" vallist="0" default="" type="int">rename</param>

5375

5376

<insert>fdf_add_template(resource fdfdoc, int newpage, string filename, string template, int rename);</insert>

5377

<dialog title="Insert fdf_add_template">fdf_add_template(%0, %1, %2, %3, %4);</dialog>

5378

5379

</function>

5380

5381

<description>Close an FDF document</description>

5382

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5383

5384

<insert>fdf_close(resource fdf_document);</insert>

5385

<dialog title="Insert fdf_close">fdf_close(%0);</dialog>

5386

5387

</function>

5388

5389

<description>Create a new FDF document</description>

5390

<return type="resource">resource</return>

5391

<insert>fdf_create();</insert>

5392

<dialog title="Insert fdf_create">fdf_create();</dialog>

5393

5394

</function>

5395

5396

<description>Call a user defined function for each document value </description>

5397

<param name="fdfdoc" required="1" vallist="0" default="" type="resource">fdfdoc</param>

5398

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

5399

<param name="userdata" required="0" vallist="0" default="" type="mixed">userdata</param>

5400

5401

<insert>fdf_enum_values(resource fdfdoc, callback function [,mixed userdata]);</insert>

5402

<dialog title="Insert fdf_enum_values">fdf_enum_values(%0, %1, %2);</dialog>

5403

5404

</function>

5405

5406

<description>Return error code for last fdf operation</description>

5407

5408

<insert>fdf_errno();</insert>

5409

<dialog title="Insert fdf_errno">fdf_errno();</dialog>

5410

5411

</function>

5412

5413

<description>Return error description for fdf error code</description>

5414

<param name="error_code" required="0" vallist="0" default="" type="int">error_code</param>

5415

<return type="string">string</return>

5416

<insert>fdf_error([int error_code]);</insert>

5417

<dialog title="Insert fdf_error">fdf_error(%0);</dialog>

5418

5419

</function>

5420

5421

<description>Get the appearance of a field</description>

5422

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5423

<param name="field" required="1" vallist="0" default="" type="string">field</param>

5424

5425

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5426

5427

<insert>fdf_get_ap(resource fdf_document, string field, int face, string filename);</insert>

5428

5429

5430

</function>

5431

5432

<description>Extracts uploaded file embedded in the FDF</description>

5433

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5434

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5435

<param name="savepath" required="1" vallist="0" default="" type="string">savepath</param>

5436

<return type="array">array</return>

5437

<insert>fdf_get_attachment(resource fdf_document, string fieldname, string savepath);</insert>

5438

<dialog title="Insert fdf_get_attachment">fdf_get_attachment(%0, %1, %2);</dialog>

5439

5440

</function>

5441

5442

<description>Get the value of the /Encoding key</description>

5443

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5444

<return type="string">string</return>

5445

<insert>fdf_get_encoding(resource fdf_document);</insert>

5446

<dialog title="Insert fdf_get_encoding">fdf_get_encoding(%0);</dialog>

5447

5448

</function>

5449

5450

<description>Get the value of the /F key</description>

5451

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5452

<return type="string">string</return>

5453

<insert>fdf_get_file(resource fdf_document);</insert>

5454

5455

5456

</function>

5457

5458

<description>Gets the flags of a field</description>

5459

5460

<insert>fdf_get_flags();</insert>

5461

<dialog title="Insert fdf_get_flags">fdf_get_flags();</dialog>

5462

5463

</function>

5464

5465

<description>Gets a value from the opt array of a field</description>

5466

<param name="fdfdof" required="1" vallist="0" default="" type="resource">fdfdof</param>

5467

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5468

<param name="element" required="0" vallist="0" default="" type="int">element</param>

5469

<return type="mixed">mixed</return>

5470

<insert>fdf_get_opt(resource fdfdof, string fieldname [,int element]);</insert>

5471

5472

5473

</function>

5474

5475

<description>Get the value of the /STATUS key</description>

5476

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5477

<return type="string">string</return>

5478

<insert>fdf_get_status(resource fdf_document);</insert>

5479

<dialog title="Insert fdf_get_status">fdf_get_status(%0);</dialog>

5480

5481

</function>

5482

5483

<description>Get the value of a field</description>

5484

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5485

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5486

<param name="which" required="0" vallist="0" default="" type="int">which</param>

5487

<return type="string">string</return>

5488

<insert>fdf_get_value(resource fdf_document, string fieldname [,int which]);</insert>

5489

<dialog title="Insert fdf_get_value">fdf_get_value(%0, %1, %2);</dialog>

5490

5491

</function>

5492

5493

<description>Gets version number for FDF api or file </description>

5494

<param name="fdf_document" required="0" vallist="0" default="" type="resource">fdf_document</param>

5495

<return type="string">string</return>

5496

<insert>fdf_get_version([resource fdf_document]);</insert>

5497

<dialog title="Insert fdf_get_version">fdf_get_version(%0);</dialog>

5498

5499

</function>

5500

5501

<description>Sets FDF-specific output headers</description>

5502

5503

<insert>fdf_header();</insert>

5504

<dialog title="Insert fdf_header">fdf_header();</dialog>

5505

5506

</function>

5507

5508

<description>Get the next field name</description>

5509

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5510

<param name="fieldname" required="0" vallist="0" default="" type="string">fieldname</param>

5511

<return type="string">string</return>

5512

<insert>fdf_next_field_name(resource fdf_document [,string fieldname]);</insert>

5513

<dialog title="Insert fdf_next_field_name">fdf_next_field_name(%0, %1);</dialog>

5514

5515

</function>

5516

5517

<description>Read a FDF document from a string</description>

5518

5519

<return type="resource">resource</return>

5520

<insert>fdf_open_string(string fdf_data);</insert>

5521

<dialog title="Insert fdf_open_string">fdf_open_string(%0);</dialog>

5522

5523

</function>

5524

5525

<description>Open a FDF document</description>

5526

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5527

<return type="resource">resource</return>

5528

<insert>fdf_open(string filename);</insert>

5529

5530

5531

</function>

5532

5533

<description>Sets target frame for form</description>

5534

<param name="fdfdoc" required="1" vallist="0" default="" type="resource">fdfdoc</param>

5535

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5536

5537

5538

<insert>fdf_remove_item(resource fdfdoc, string fieldname, int item);</insert>

5539

<dialog title="Insert fdf_remove_item">fdf_remove_item(%0, %1, %2);</dialog>

5540

5541

</function>

5542

5543

<description>Returns the FDF document as a string</description>

5544

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5545

<return type="string">string</return>

5546

<insert>fdf_save_string(resource fdf_document);</insert>

5547

<dialog title="Insert fdf_save_string">fdf_save_string(%0);</dialog>

5548

5549

</function>

5550

5551

<description>Save a FDF document</description>

5552

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5553

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

5554

5555

<insert>fdf_save(resource fdf_document [,string filename]);</insert>

5556

5557

5558

</function>

5559

5560

<description>Set the appearance of a field</description>

5561

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5562

<param name="field_name" required="1" vallist="0" default="" type="string">field_name</param>

5563

5564

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5565

<param name="page_number" required="1" vallist="0" default="" type="int">page_number</param>

5566

5567

<insert>fdf_set_ap(resource fdf_document, string field_name, int face, string filename, int page_number);</insert>

5568

5569

5570

</function>

5571

5572

<description>Sets FDF character encoding</description>

5573

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5574

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

5575

5576

<insert>fdf_set_encoding(resource fdf_document, string encoding);</insert>

5577

<dialog title="Insert fdf_set_encoding">fdf_set_encoding(%0, %1);</dialog>

5578

5579

</function>

5580

5581

<description>Set PDF document to display FDF data in</description>

5582

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5583

5584

<param name="target_frame" required="0" vallist="0" default="" type="string">target_frame</param>

5585

5586

<insert>fdf_set_file(resource fdf_document, string url [,string target_frame]);</insert>

5587

5588

5589

</function>

5590

5591

<description>Sets a flag of a field</description>

5592

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5593

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5594

<param name="whichFlags" required="1" vallist="0" default="" type="int">whichFlags</param>

5595

<param name="newFlags" required="1" vallist="0" default="" type="int">newFlags</param>

5596

5597

<insert>fdf_set_flags(resource fdf_document, string fieldname, int whichFlags, int newFlags);</insert>

5598

<dialog title="Insert fdf_set_flags">fdf_set_flags(%0, %1, %2, %3);</dialog>

5599

5600

</function>

5601

5602

<description>Sets an javascript action of a field</description>

5603

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5604

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5605

<param name="trigger" required="1" vallist="0" default="" type="int">trigger</param>

5606

<param name="script" required="1" vallist="0" default="" type="string">script</param>

5607

5608

<insert>fdf_set_javascript_action(resource fdf_document, string fieldname, int trigger, string script);</insert>

5609

<dialog title="Insert fdf_set_javascript_action">fdf_set_javascript_action(%0, %1, %2, %3);</dialog>

5610

5611

</function>

5612

5613

<description>Sets an option of a field</description>

5614

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5615

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5616

<param name="element" required="1" vallist="0" default="" type="int">element</param>

5617

5618

5619

5620

<insert>fdf_set_opt(resource fdf_document, string fieldname, int element, string str1, string str2);</insert>

5621

5622

5623

</function>

5624

5625

<description>Set the value of the /STATUS key</description>

5626

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5627

<param name="status" required="1" vallist="0" default="" type="string">status</param>

5628

5629

<insert>fdf_set_status(resource fdf_document, string status);</insert>

5630

<dialog title="Insert fdf_set_status">fdf_set_status(%0, %1);</dialog>

5631

5632

</function>

5633

5634

<description>Sets a submit form action of a field</description>

5635

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5636

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5637

<param name="trigger" required="1" vallist="0" default="" type="int">trigger</param>

5638

<param name="script" required="1" vallist="0" default="" type="string">script</param>

5639

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

5640

5641

<insert>fdf_set_submit_form_action(resource fdf_document, string fieldname, int trigger, string script, int flags);</insert>

5642

<dialog title="Insert fdf_set_submit_form_action">fdf_set_submit_form_action(%0, %1, %2, %3, %4);</dialog>

5643

5644

</function>

5645

5646

<description>Set target frame for form display</description>

5647

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5648

<param name="frame_name" required="1" vallist="0" default="" type="string">frame_name</param>

5649

5650

<insert>fdf_set_target_frame(resource fdf_document, string frame_name);</insert>

5651

<dialog title="Insert fdf_set_target_frame">fdf_set_target_frame(%0, %1);</dialog>

5652

5653

</function>

5654

5655

<description>Set the value of a field</description>

5656

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5657

<param name="fieldname" required="1" vallist="0" default="" type="string">fieldname</param>

5658

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

5659

<param name="isName" required="0" vallist="0" default="" type="int">isName</param>

5660

5661

<insert>fdf_set_value(resource fdf_document, string fieldname, mixed value [,int isName]);</insert>

5662

<dialog title="Insert fdf_set_value">fdf_set_value(%0, %1, %2, %3);</dialog>

5663

5664

</function>

5665

5666

<description>Sets version number for a FDF file </description>

5667

<param name="fdf_document" required="1" vallist="0" default="" type="resource">fdf_document</param>

5668

<param name="version" required="1" vallist="0" default="" type="string">version</param>

5669

<return type="string">string</return>

5670

<insert>fdf_set_version(resource fdf_document, string version);</insert>

5671

<dialog title="Insert fdf_set_version">fdf_set_version(%0, %1);</dialog>

5672

5673

</function>

5674

</group>

5675

5676

5677

<description>Find out how many fields are in a filePro database</description>

5678

5679

<insert>filepro_fieldcount();</insert>

5680

<dialog title="Insert filepro_fieldcount">filepro_fieldcount();</dialog>

5681

5682

</function>

5683

5684

<description>Gets the name of a field</description>

5685

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

5686

<return type="string">string</return>

5687

<insert>filepro_fieldname(int field_number);</insert>

5688

<dialog title="Insert filepro_fieldname">filepro_fieldname(%0);</dialog>

5689

5690

</function>

5691

5692

<description>Gets the type of a field</description>

5693

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

5694

<return type="string">string</return>

5695

<insert>filepro_fieldtype(int field_number);</insert>

5696

<dialog title="Insert filepro_fieldtype">filepro_fieldtype(%0);</dialog>

5697

5698

</function>

5699

5700

<description>Gets the width of a field</description>

5701

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

5702

5703

<insert>filepro_fieldwidth(int field_number);</insert>

5704

<dialog title="Insert filepro_fieldwidth">filepro_fieldwidth(%0);</dialog>

5705

5706

</function>

5707

5708

<description>Retrieves data from a filePro database</description>

5709

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

5710

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

5711

<return type="string">string</return>

5712

<insert>filepro_retrieve(int row_number, int field_number);</insert>

5713

<dialog title="Insert filepro_retrieve">filepro_retrieve(%0, %1);</dialog>

5714

5715

</function>

5716

5717

<description>Find out how many rows are in a filePro database</description>

5718

5719

<insert>filepro_rowcount();</insert>

5720

<dialog title="Insert filepro_rowcount">filepro_rowcount();</dialog>

5721

5722

</function>

5723

5724

<description>Read and verify the map file</description>

5725

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

5726

5727

<insert>filepro(string directory);</insert>

5728

<dialog title="Insert filepro">filepro(%0);</dialog>

5729

5730

</function>

5731

</group>

5732

5733

5734

<description>Returns filename component of path</description>

5735

5736

<param name="suffix" required="0" vallist="0" default="" type="string">suffix</param>

5737

<return type="string">string</return>

5738

<insert>basename(string path [,string suffix]);</insert>

5739

<dialog title="Insert basename">basename(%0, %1);</dialog>

5740

5741

</function>

5742

5743

<description>Changes file group</description>

5744

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5745

<param name="group" required="1" vallist="0" default="" type="mixed">group</param>

5746

5747

<insert>chgrp(string filename, mixed group);</insert>

5748

<dialog title="Insert chgrp">chgrp(%0, %1);</dialog>

5749

5750

</function>

5751

5752

<description>Changes file mode</description>

5753

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5754

5755

5756

<insert>chmod(string filename, int mode);</insert>

5757

<dialog title="Insert chmod">chmod(%0, %1);</dialog>

5758

5759

</function>

5760

5761

<description>Changes file owner</description>

5762

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5763

5764

5765

<insert>chown(string filename, mixed user);</insert>

5766

<dialog title="Insert chown">chown(%0, %1);</dialog>

5767

5768

</function>

5769

5770

<description>Clears file status cache</description>

5771

5772

<insert>clearstatcache();</insert>

5773

<dialog title="Insert clearstatcache">clearstatcache();</dialog>

5774

5775

</function>

5776

5777

<description>Copies file</description>

5778

<param name="source" required="1" vallist="0" default="" type="string">source</param>

5779

5780

5781

<insert>copy(string source, string dest);</insert>

5782

5783

5784

</function>

5785

5786

5787

5788

5789

<insert>delete(string file);</insert>

5790

<dialog title="Insert delete">delete(%0);</dialog>

5791

5792

</function>

5793

5794

<description>Returns directory name component of path</description>

5795

5796

<return type="string">string</return>

5797

<insert>dirname(string path);</insert>

5798

<dialog title="Insert dirname">dirname(%0);</dialog>

5799

5800

</function>

5801

5802

<description>Returns available space in directory</description>

5803

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

5804

<return type="float">float</return>

5805

<insert>disk_free_space(string directory);</insert>

5806

<dialog title="Insert disk_free_space">disk_free_space(%0);</dialog>

5807

5808

</function>

5809

5810

<description>Returns the total size of a directory</description>

5811

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

5812

<return type="float">float</return>

5813

<insert>disk_total_space(string directory);</insert>

5814

<dialog title="Insert disk_total_space">disk_total_space(%0);</dialog>

5815

5816

</function>

5817

5818

<description>Closes an open file pointer</description>

5819

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5820

5821

<insert>fclose(resource handle);</insert>

5822

<dialog title="Insert fclose">fclose(%0);</dialog>

5823

5824

</function>

5825

5826

<description>Tests for end-of-file on a file pointer</description>

5827

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5828

5829

<insert>feof(resource handle);</insert>

5830

5831

5832

</function>

5833

5834

<description>Flushes the output to a file</description>

5835

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5836

5837

<insert>fflush(resource handle);</insert>

5838

<dialog title="Insert fflush">fflush(%0);</dialog>

5839

5840

</function>

5841

5842

<description>Gets character from file pointer</description>

5843

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5844

<return type="string">string</return>

5845

<insert>fgetc(resource handle);</insert>

5846

<dialog title="Insert fgetc">fgetc(%0);</dialog>

5847

5848

</function>

5849

5850

<description>Gets line from file pointer and parse for CSV fields</description>

5851

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5852

<param name="length" required="1" vallist="0" default="" type="int">length</param>

5853

<param name="delimiter" required="0" vallist="0" default="" type="string">delimiter</param>

5854

<param name="enclosure" required="0" vallist="0" default="" type="string">enclosure</param>

5855

<return type="array">array</return>

5856

<insert>fgetcsv(resource handle, int length [,string delimiter] [,string enclosure]);</insert>

5857

<dialog title="Insert fgetcsv">fgetcsv(%0, %1, %2, %3);</dialog>

5858

5859

</function>

5860

5861

<description>Gets line from file pointer</description>

5862

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5863

<param name="length" required="0" vallist="0" default="" type="int">length</param>

5864

<return type="string">string</return>

5865

<insert>fgets(resource handle [,int length]);</insert>

5866

<dialog title="Insert fgets">fgets(%0, %1);</dialog>

5867

5868

</function>

5869

5870

<description>Gets line from file pointer and strip HTML tags</description>

5871

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5872

<param name="length" required="1" vallist="0" default="" type="int">length</param>

5873

<param name="allowable_tags" required="0" vallist="0" default="" type="string">allowable_tags</param>

5874

<return type="string">string</return>

5875

<insert>fgetss(resource handle, int length [,string allowable_tags]);</insert>

5876

<dialog title="Insert fgetss">fgetss(%0, %1, %2);</dialog>

5877

5878

</function>

5879

5880

<description>Checks whether a file or directory exists</description>

5881

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5882

5883

<insert>file_exists(string filename);</insert>

5884

<dialog title="Insert file_exists">file_exists(%0);</dialog>

5885

5886

</function>

5887

5888

<description>Reads entire file into a string</description>

5889

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5890

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

5891

<return type="string">string</return>

5892

<insert>file_get_contents(string filename [,int use_include_path]);</insert>

5893

<dialog title="Insert file_get_contents">file_get_contents(%0, %1);</dialog>

5894

5895

</function>

5896

5897

<description>Reads entire file into an array</description>

5898

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5899

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

5900

<return type="array">array</return>

5901

<insert>file(string filename [,int use_include_path]);</insert>

5902

5903

5904

</function>

5905

5906

<description>Gets last access time of file</description>

5907

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5908

5909

<insert>fileatime(string filename);</insert>

5910

<dialog title="Insert fileatime">fileatime(%0);</dialog>

5911

5912

</function>

5913

5914

<description>Gets inode change time of file</description>

5915

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5916

5917

<insert>filectime(string filename);</insert>

5918

<dialog title="Insert filectime">filectime(%0);</dialog>

5919

5920

</function>

5921

5922

<description>Gets file group</description>

5923

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5924

5925

<insert>filegroup(string filename);</insert>

5926

<dialog title="Insert filegroup">filegroup(%0);</dialog>

5927

5928

</function>

5929

5930

<description>Gets file inode</description>

5931

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5932

5933

<insert>fileinode(string filename);</insert>

5934

<dialog title="Insert fileinode">fileinode(%0);</dialog>

5935

5936

</function>

5937

5938

<description>Gets file modification time</description>

5939

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5940

5941

<insert>filemtime(string filename);</insert>

5942

<dialog title="Insert filemtime">filemtime(%0);</dialog>

5943

5944

</function>

5945

5946

<description>Gets file owner</description>

5947

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5948

5949

<insert>fileowner(string filename);</insert>

5950

<dialog title="Insert fileowner">fileowner(%0);</dialog>

5951

5952

</function>

5953

5954

<description>Gets file permissions</description>

5955

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5956

5957

<insert>fileperms(string filename);</insert>

5958

<dialog title="Insert fileperms">fileperms(%0);</dialog>

5959

5960

</function>

5961

5962

5963

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5964

5965

<insert>filesize(string filename);</insert>

5966

<dialog title="Insert filesize">filesize(%0);</dialog>

5967

5968

</function>

5969

5970

5971

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

5972

<return type="string">string</return>

5973

<insert>filetype(string filename);</insert>

5974

<dialog title="Insert filetype">filetype(%0);</dialog>

5975

5976

</function>

5977

5978

<description>Portable advisory file locking</description>

5979

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

5980

<param name="operation" required="1" vallist="0" default="" type="int">operation</param>

5981

<param name="&wouldblock" required="0" vallist="0" default="" type="int">&wouldblock</param>

5982

5983

<insert>flock(resource handle, int operation [,int &wouldblock]);</insert>

5984

<dialog title="Insert flock">flock(%0, %1, %2);</dialog>

5985

5986

</function>

5987

5988

<description>Match filename against a pattern</description>

5989

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

5990

<param name="string" required="1" vallist="0" default="" type="string">string</param>

5991

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

5992

<return type="array">array</return>

5993

<insert>fnmatch(string pattern, string string [,int flags]);</insert>

5994

<dialog title="Insert fnmatch">fnmatch(%0, %1, %2);</dialog>

5995

5996

</function>

5997

5998

<description>Opens file or URL</description>

5999

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6000

6001

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

6002

<param name="zcontext" required="0" vallist="0" default="" type="resource">zcontext</param>

6003

<return type="resource">resource</return>

6004

<insert>fopen(string filename, string mode [,int use_include_path] [,resource zcontext]);</insert>

6005

<dialog title="Insert fopen">fopen(%0, %1, %2, %3);</dialog>

6006

6007

</function>

6008

6009

<description>Output all remaining data on a file pointer</description>

6010

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6011

6012

<insert>fpassthru(resource handle);</insert>

6013

<dialog title="Insert fpassthru">fpassthru(%0);</dialog>

6014

6015

</function>

6016

6017

<description>Binary-safe file read</description>

6018

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6019

<param name="length" required="1" vallist="0" default="" type="int">length</param>

6020

<return type="string">string</return>

6021

<insert>fread(resource handle, int length);</insert>

6022

<dialog title="Insert fread">fread(%0, %1);</dialog>

6023

6024

</function>

6025

6026

<description>Parses input from a file according to a format</description>

6027

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6028

<param name="format" required="1" vallist="0" default="" type="string">format</param>

6029

6030

<return type="mixed">mixed</return>

6031

<insert>fscanf(resource handle, string format [,string var1]);</insert>

6032

<dialog title="Insert fscanf">fscanf(%0, %1, %2);</dialog>

6033

6034

</function>

6035

6036

<description>Seeks on a file pointer</description>

6037

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6038

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

6039

<param name="whence" required="0" vallist="0" default="" type="int">whence</param>

6040

6041

<insert>fseek(resource handle, int offset [,int whence]);</insert>

6042

<dialog title="Insert fseek">fseek(%0, %1, %2);</dialog>

6043

6044

</function>

6045

6046

<description>Gets information about a file using an open file pointer</description>

6047

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6048

<return type="array">array</return>

6049

<insert>fstat(resource handle);</insert>

6050

<dialog title="Insert fstat">fstat(%0);</dialog>

6051

6052

</function>

6053

6054

<description>Tells file pointer read/write position</description>

6055

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6056

6057

<insert>ftell(resource handle);</insert>

6058

<dialog title="Insert ftell">ftell(%0);</dialog>

6059

6060

</function>

6061

6062

<description>Truncates a file to a given length</description>

6063

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6064

6065

6066

<insert>ftruncate(resource handle, int size);</insert>

6067

<dialog title="Insert ftruncate">ftruncate(%0, %1);</dialog>

6068

6069

</function>

6070

6071

<description>Binary-safe file write</description>

6072

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6073

<param name="string" required="1" vallist="0" default="" type="string">string</param>

6074

<param name="length" required="0" vallist="0" default="" type="int">length</param>

6075

6076

<insert>fwrite(resource handle, string string [,int length]);</insert>

6077

<dialog title="Insert fwrite">fwrite(%0, %1, %2);</dialog>

6078

6079

</function>

6080

6081

<description>Find pathnames matching a pattern</description>

6082

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

6083

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

6084

<return type="array">array</return>

6085

<insert>glob(string pattern [,int flags]);</insert>

6086

6087

6088

</function>

6089

6090

<description>Tells whether the filename is a directory</description>

6091

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6092

6093

<insert>is_dir(string filename);</insert>

6094

6095

6096

</function>

6097

6098

<description>Tells whether the filename is executable</description>

6099

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6100

6101

<insert>is_executable(string filename);</insert>

6102

<dialog title="Insert is_executable">is_executable(%0);</dialog>

6103

6104

</function>

6105

6106

<description>Tells whether the filename is a regular file</description>

6107

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6108

6109

<insert>is_file(string filename);</insert>

6110

6111

6112

</function>

6113

6114

<description>Tells whether the filename is a symbolic link</description>

6115

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6116

6117

<insert>is_link(string filename);</insert>

6118

6119

6120

</function>

6121

6122

<description>Tells whether the filename is readable</description>

6123

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6124

6125

<insert>is_readable(string filename);</insert>

6126

<dialog title="Insert is_readable">is_readable(%0);</dialog>

6127

6128

</function>

6129

6130

<description>Tells whether the file was uploaded via HTTP POST</description>

6131

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6132

6133

<insert>is_uploaded_file(string filename);</insert>

6134

<dialog title="Insert is_uploaded_file">is_uploaded_file(%0);</dialog>

6135

6136

</function>

6137

6138

<description>Tells whether the filename is writable</description>

6139

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6140

6141

<insert>is_writable(string filename);</insert>

6142

<dialog title="Insert is_writable">is_writable(%0);</dialog>

6143

6144

</function>

6145

6146

<description>Create a hard link</description>

6147

<param name="target" required="1" vallist="0" default="" type="string">target</param>

6148

6149

6150

<insert>link(string target, string link);</insert>

6151

6152

6153

</function>

6154

6155

<description>Gets information about a link</description>

6156

6157

6158

<insert>linkinfo(string path);</insert>

6159

<dialog title="Insert linkinfo">linkinfo(%0);</dialog>

6160

6161

</function>

6162

6163

<description>Gives information about a file or symbolic link</description>

6164

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6165

<return type="array">array</return>

6166

<insert>lstat(string filename);</insert>

6167

<dialog title="Insert lstat">lstat(%0);</dialog>

6168

6169

</function>

6170

6171

<description>Makes directory</description>

6172

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

6173

6174

6175

<insert>mkdir(string pathname [,int mode]);</insert>

6176

<dialog title="Insert mkdir">mkdir(%0, %1);</dialog>

6177

6178

</function>

6179

6180

<description>Moves an uploaded file to a new location</description>

6181

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6182

<param name="destination" required="1" vallist="0" default="" type="string">destination</param>

6183

6184

<insert>move_uploaded_file(string filename, string destination);</insert>

6185

<dialog title="Insert move_uploaded_file">move_uploaded_file(%0, %1);</dialog>

6186

6187

</function>

6188

6189

<description>Parse a configuration file</description>

6190

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6191

<param name="process_sections" required="0" vallist="0" default="" type="bool">process_sections</param>

6192

<return type="array">array</return>

6193

<insert>parse_ini_file(string filename [,bool process_sections]);</insert>

6194

<dialog title="Insert parse_ini_file">parse_ini_file(%0, %1);</dialog>

6195

6196

</function>

6197

6198

<description>Returns information about a file path</description>

6199

6200

<return type="array">array</return>

6201

<insert>pathinfo(string path);</insert>

6202

<dialog title="Insert pathinfo">pathinfo(%0);</dialog>

6203

6204

</function>

6205

6206

<description>Closes process file pointer</description>

6207

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6208

6209

<insert>pclose(resource handle);</insert>

6210

<dialog title="Insert pclose">pclose(%0);</dialog>

6211

6212

</function>

6213

6214

<description>Opens process file pointer</description>

6215

<param name="command" required="1" vallist="0" default="" type="string">command</param>

6216

6217

<return type="resource">resource</return>

6218

<insert>popen(string command, string mode);</insert>

6219

<dialog title="Insert popen">popen(%0, %1);</dialog>

6220

6221

</function>

6222

6223

<description>Outputs a file</description>

6224

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6225

<param name="use_include_path" required="0" vallist="0" default="" type="bool">use_include_path</param>

6226

6227

<insert>readfile(string filename [,bool use_include_path]);</insert>

6228

<dialog title="Insert readfile">readfile(%0, %1);</dialog>

6229

6230

</function>

6231

6232

<description>Returns the target of a symbolic link</description>

6233

6234

<return type="string">string</return>

6235

<insert>readlink(string path);</insert>

6236

<dialog title="Insert readlink">readlink(%0);</dialog>

6237

6238

</function>

6239

6240

<description>Returns canonicalized absolute pathname</description>

6241

6242

<return type="string">string</return>

6243

<insert>realpath(string path);</insert>

6244

<dialog title="Insert realpath">realpath(%0);</dialog>

6245

6246

</function>

6247

6248

<description>Renames a file</description>

6249

<param name="oldname" required="1" vallist="0" default="" type="string">oldname</param>

6250

<param name="newname" required="1" vallist="0" default="" type="string">newname</param>

6251

6252

<insert>rename(string oldname, string newname);</insert>

6253

<dialog title="Insert rename">rename(%0, %1);</dialog>

6254

6255

</function>

6256

6257

<description>Rewind the position of a file pointer</description>

6258

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6259

6260

<insert>rewind(resource handle);</insert>

6261

<dialog title="Insert rewind">rewind(%0);</dialog>

6262

6263

</function>

6264

6265

<description>Removes directory</description>

6266

<param name="dirname" required="1" vallist="0" default="" type="string">dirname</param>

6267

6268

<insert>rmdir(string dirname);</insert>

6269

<dialog title="Insert rmdir">rmdir(%0);</dialog>

6270

6271

</function>

6272

6273

<description>Gives information about a file</description>

6274

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6275

<return type="array">array</return>

6276

<insert>stat(string filename);</insert>

6277

6278

6279

</function>

6280

6281

<description>Creates a symbolic link</description>

6282

<param name="target" required="1" vallist="0" default="" type="string">target</param>

6283

6284

6285

<insert>symlink(string target, string link);</insert>

6286

<dialog title="Insert symlink">symlink(%0, %1);</dialog>

6287

6288

</function>

6289

6290

<description>Create file with unique file name</description>

6291

6292

<param name="prefix" required="1" vallist="0" default="" type="string">prefix</param>

6293

<return type="string">string</return>

6294

<insert>tempnam(string dir, string prefix);</insert>

6295

<dialog title="Insert tempnam">tempnam(%0, %1);</dialog>

6296

6297

</function>

6298

6299

<description>Creates a temporary file</description>

6300

<return type="resource">resource</return>

6301

<insert>tmpfile();</insert>

6302

<dialog title="Insert tmpfile">tmpfile();</dialog>

6303

6304

</function>

6305

6306

<description>Sets access and modification time of file</description>

6307

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6308

6309

<param name="atime" required="0" vallist="0" default="" type="int">atime</param>

6310

6311

<insert>touch(string filename [,int time] [,int atime]);</insert>

6312

<dialog title="Insert touch">touch(%0, %1, %2);</dialog>

6313

6314

</function>

6315

6316

<description>Changes the current umask</description>

6317

6318

6319

<insert>umask([int mask]);</insert>

6320

<dialog title="Insert umask">umask(%0);</dialog>

6321

6322

</function>

6323

6324

<description>Deletes a file</description>

6325

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6326

6327

<insert>unlink(string filename);</insert>

6328

<dialog title="Insert unlink">unlink(%0);</dialog>

6329

6330

</function>

6331

</group>

6332

6333

6334

<description>Convert a logical string to a visual one</description>

6335

6336

<param name="direction" required="1" vallist="0" default="" type="string">direction</param>

6337

<param name="charset" required="1" vallist="0" default="" type="int">charset</param>

6338

<return type="string">string</return>

6339

<insert>fribidi_log2vis(string str, string direction, int charset);</insert>

6340

<dialog title="Insert fribidi_log2vis">fribidi_log2vis(%0, %1, %2);</dialog>

6341

6342

</function>

6343

</group>

6344

6345

6346

<description>Changes to the parent directory</description>

6347

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6348

6349

<insert>ftp_cdup(resource ftp_stream);</insert>

6350

6351

6352

</function>

6353

6354

<description>Changes directories on a FTP server</description>

6355

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6356

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6357

6358

<insert>ftp_chdir(resource ftp_stream, string directory);</insert>

6359

<dialog title="Insert ftp_chdir">ftp_chdir(%0, %1);</dialog>

6360

6361

</function>

6362

6363

<description>Set permissions on a file via FTP</description>

6364

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6365

6366

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

6367

<return type="string">string</return>

6368

<insert>ftp_chmod(resource ftp_stream, int mode, string filename);</insert>

6369

<dialog title="Insert ftp_chmod">ftp_chmod(%0, %1, %2);</dialog>

6370

6371

</function>

6372

6373

<description>Closes an FTP connection</description>

6374

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6375

6376

<insert>ftp_close(resource ftp_stream);</insert>

6377

<dialog title="Insert ftp_close">ftp_close(%0);</dialog>

6378

6379

</function>

6380

6381

<description>Opens an FTP connection</description>

6382

6383

6384

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

6385

<return type="resource">resource</return>

6386

<insert>ftp_connect(string host [,int port] [,int timeout]);</insert>

6387

<dialog title="Insert ftp_connect">ftp_connect(%0, %1, %2);</dialog>

6388

6389

</function>

6390

6391

<description>Deletes a file on the FTP server</description>

6392

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6393

6394

6395

<insert>ftp_delete(resource ftp_stream, string path);</insert>

6396

<dialog title="Insert ftp_delete">ftp_delete(%0, %1);</dialog>

6397

6398

</function>

6399

6400

<description>Requests execution of a program on the FTP server</description>

6401

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6402

<param name="command" required="1" vallist="0" default="" type="string">command</param>

6403

6404

<insert>ftp_exec(resource ftp_stream, string command);</insert>

6405

6406

6407

</function>

6408

6409

<description>Downloads a file from the FTP server and saves to an open file</description>

6410

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6411

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6412

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6413

6414

<param name="resumepos" required="0" vallist="0" default="" type="int">resumepos</param>

6415

6416

<insert>ftp_fget(resource ftp_stream, resource handle, string remote_file, int mode [,int resumepos]);</insert>

6417

6418

6419

</function>

6420

6421

<description>Uploads from an open file to the FTP server</description>

6422

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6423

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6424

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6425

6426

<param name="startpos" required="0" vallist="0" default="" type="int">startpos</param>

6427

6428

<insert>ftp_fput(resource ftp_stream, string remote_file, resource handle, int mode [,int startpos]);</insert>

6429

6430

6431

</function>

6432

6433

<description>Retrieves various runtime behaviours of the current FTP stream</description>

6434

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6435

<param name="option" required="1" vallist="0" default="" type="int">option</param>

6436

<return type="mixed">mixed</return>

6437

<insert>ftp_get_option(resource ftp_stream, int option);</insert>

6438

<dialog title="Insert ftp_get_option">ftp_get_option(%0, %1);</dialog>

6439

6440

</function>

6441

6442

<description>Downloads a file from the FTP server</description>

6443

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6444

<param name="local_file" required="1" vallist="0" default="" type="string">local_file</param>

6445

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6446

6447

<param name="resumepos" required="0" vallist="0" default="" type="int">resumepos</param>

6448

6449

<insert>ftp_get(resource ftp_stream, string local_file, string remote_file, int mode [,int resumepos]);</insert>

6450

6451

6452

</function>

6453

6454

<description>Logs in to an FTP connection</description>

6455

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6456

<param name="username" required="1" vallist="0" default="" type="string">username</param>

6457

<param name="password" required="1" vallist="0" default="" type="string">password</param>

6458

6459

<insert>ftp_login(resource ftp_stream, string username, string password);</insert>

6460

<dialog title="Insert ftp_login">ftp_login(%0, %1, %2);</dialog>

6461

6462

</function>

6463

6464

<description>Returns the last modified time of the given file</description>

6465

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6466

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6467

6468

<insert>ftp_mdtm(resource ftp_stream, string remote_file);</insert>

6469

6470

6471

</function>

6472

6473

<description>Creates a directory</description>

6474

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6475

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6476

<return type="string">string</return>

6477

<insert>ftp_mkdir(resource ftp_stream, string directory);</insert>

6478

<dialog title="Insert ftp_mkdir">ftp_mkdir(%0, %1);</dialog>

6479

6480

</function>

6481

6482

<description>Continues retrieving/sending a file (non-blocking)</description>

6483

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6484

6485

<insert>ftp_nb_continue(resource ftp_stream);</insert>

6486

<dialog title="Insert ftp_nb_continue">ftp_nb_continue(%0);</dialog>

6487

6488

</function>

6489

6490

<description>Retrieves a file from the FTP server and writes it to an open file (non-blocking)</description>

6491

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6492

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6493

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6494

6495

<param name="resumepos" required="0" vallist="0" default="" type="int">resumepos</param>

6496

6497

<insert>ftp_nb_fget(resource ftp_stream, resource handle, string remote_file, int mode [,int resumepos]);</insert>

6498

6499

6500

</function>

6501

6502

<description>Stores a file from an open file to the FTP server (non-blocking)</description>

6503

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6504

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6505

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

6506

6507

<param name="startpos" required="0" vallist="0" default="" type="int">startpos</param>

6508

6509

<insert>ftp_nb_fput(resource ftp_stream, string remote_file, resource handle, int mode [,int startpos]);</insert>

6510

6511

6512

</function>

6513

6514

<description>Retrieves a file from the FTP server and writes it to a local file (non-blocking)</description>

6515

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6516

<param name="local_file" required="1" vallist="0" default="" type="string">local_file</param>

6517

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6518

6519

<param name="resumepos" required="0" vallist="0" default="" type="int">resumepos</param>

6520

6521

<insert>ftp_nb_get(resource ftp_stream, string local_file, string remote_file, int mode [,int resumepos]);</insert>

6522

6523

6524

</function>

6525

6526

<description>Stores a file on the FTP server (non-blocking)</description>

6527

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6528

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6529

<param name="local_file" required="1" vallist="0" default="" type="string">local_file</param>

6530

6531

<param name="startpos" required="0" vallist="0" default="" type="int">startpos</param>

6532

6533

<insert>ftp_nb_put(resource ftp_stream, string remote_file, string local_file, int mode [,int startpos]);</insert>

6534

6535

6536

</function>

6537

6538

<description>Returns a list of files in the given directory</description>

6539

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6540

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6541

<return type="array">array</return>

6542

<insert>ftp_nlist(resource ftp_stream, string directory);</insert>

6543

<dialog title="Insert ftp_nlist">ftp_nlist(%0, %1);</dialog>

6544

6545

</function>

6546

6547

<description>Turns passive mode on or off</description>

6548

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6549

6550

6551

<insert>ftp_pasv(resource ftp_stream, bool pasv);</insert>

6552

6553

6554

</function>

6555

6556

<description>Uploads a file to the FTP server</description>

6557

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6558

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6559

<param name="local_file" required="1" vallist="0" default="" type="string">local_file</param>

6560

6561

<param name="startpos" required="0" vallist="0" default="" type="int">startpos</param>

6562

6563

<insert>ftp_put(resource ftp_stream, string remote_file, string local_file, int mode [,int startpos]);</insert>

6564

6565

6566

</function>

6567

6568

<description>Returns the current directory name</description>

6569

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6570

<return type="string">string</return>

6571

<insert>ftp_pwd(resource ftp_stream);</insert>

6572

6573

6574

</function>

6575

6576

<description>Sends an arbitrary command to an FTP server</description>

6577

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6578

<param name="command" required="1" vallist="0" default="" type="string">command</param>

6579

<return type="array">array</return>

6580

<insert>ftp_raw(resource ftp_stream, string command);</insert>

6581

6582

6583

</function>

6584

6585

<description>Returns a detailed list of files in the given directory</description>

6586

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6587

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6588

<return type="array">array</return>

6589

<insert>ftp_rawlist(resource ftp_stream, string directory);</insert>

6590

<dialog title="Insert ftp_rawlist">ftp_rawlist(%0, %1);</dialog>

6591

6592

</function>

6593

6594

<description>Renames a file on the FTP server</description>

6595

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6596

6597

6598

6599

<insert>ftp_rename(resource ftp_stream, string from, string to);</insert>

6600

<dialog title="Insert ftp_rename">ftp_rename(%0, %1, %2);</dialog>

6601

6602

</function>

6603

6604

<description>Removes a directory</description>

6605

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6606

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6607

6608

<insert>ftp_rmdir(resource ftp_stream, string directory);</insert>

6609

<dialog title="Insert ftp_rmdir">ftp_rmdir(%0, %1);</dialog>

6610

6611

</function>

6612

6613

<description>Set miscellaneous runtime FTP options</description>

6614

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6615

<param name="option" required="1" vallist="0" default="" type="int">option</param>

6616

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

6617

6618

<insert>ftp_set_option(resource ftp_stream, int option, mixed value);</insert>

6619

<dialog title="Insert ftp_set_option">ftp_set_option(%0, %1, %2);</dialog>

6620

6621

</function>

6622

6623

<description>Sends a SITE command to the server</description>

6624

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6625

6626

6627

<insert>ftp_site(resource ftp_stream, string cmd);</insert>

6628

6629

6630

</function>

6631

6632

<description>Returns the size of the given file</description>

6633

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6634

<param name="remote_file" required="1" vallist="0" default="" type="string">remote_file</param>

6635

6636

<insert>ftp_size(resource ftp_stream, string remote_file);</insert>

6637

6638

6639

</function>

6640

6641

<description>Opens an Secure SSL-FTP connection</description>

6642

6643

6644

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

6645

<return type="resource">resource</return>

6646

<insert>ftp_ssl_connect(string host [,int port] [,int timeout]);</insert>

6647

<dialog title="Insert ftp_ssl_connect">ftp_ssl_connect(%0, %1, %2);</dialog>

6648

6649

</function>

6650

6651

<description>Returns the system type identifier of the remote FTP server</description>

6652

<param name="ftp_stream" required="1" vallist="0" default="" type="resource">ftp_stream</param>

6653

<return type="string">string</return>

6654

<insert>ftp_systype(resource ftp_stream);</insert>

6655

<dialog title="Insert ftp_systype">ftp_systype(%0);</dialog>

6656

6657

</function>

6658

</group>

6659

6660

6661

6662

Call a user function given with an array of parameters

6663

</description>

6664

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

6665

<param name="paramarr" required="0" vallist="0" default="" type="array">paramarr</param>

6666

<return type="mixed">mixed</return>

6667

<insert>call_user_func_array(callback function [,array paramarr]);</insert>

6668

<dialog title="Insert call_user_func_array">call_user_func_array(%0, %1);</dialog>

6669

6670

</function>

6671

6672

6673

Call a user function given by the first parameter

6674

</description>

6675

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

6676

<param name="parameter" required="0" vallist="0" default="" type="mixed">parameter</param>

6677

6678

<return type="mixed">mixed</return>

6679

<insert>call_user_func(callback function [,mixed parameter] [,mixed ...]);</insert>

6680

6681

6682

</function>

6683

6684

<description>Create an anonymous (lambda-style) function</description>

6685

6686

6687

<return type="string">string</return>

6688

<insert>create_function(string args, string code);</insert>

6689

<dialog title="Insert create_function">create_function(%0, %1);</dialog>

6690

6691

</function>

6692

6693

<description>Return an item from the argument list</description>

6694

6695

<return type="mixed">mixed</return>

6696

6697

6698

6699

</function>

6700

6701

6702

Returns an array comprising a function's argument list

6703

</description>

6704

<return type="array">array</return>

6705

6706

6707

6708

</function>

6709

6710

6711

Returns the number of arguments passed to the function

6712

</description>

6713

6714

6715

6716

6717

</function>

6718

6719

6720

Return </description>

6721

<param name="function_name" required="1" vallist="0" default="" type="string">function_name</param>

6722

6723

<insert>function_exists(string function_name);</insert>

6724

<dialog title="Insert function_exists">function_exists(%0);</dialog>

6725

6726

</function>

6727

6728

6729

Returns an array of all defined functions

6730

</description>

6731

<return type="array">array</return>

6732

<insert>get_defined_functions();</insert>

6733

<dialog title="Insert get_defined_functions">get_defined_functions();</dialog>

6734

6735

</function>

6736

6737

6738

Register a function for execution on shutdown

6739

</description>

6740

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

6741

6742

<insert>register_shutdown_function(callback function);</insert>

6743

<dialog title="Insert register_shutdown_function">register_shutdown_function(%0);</dialog>

6744

6745

</function>

6746

6747

6748

Register a function for execution on each tick

6749

</description>

6750

<param name="function" required="1" vallist="0" default="" type="callback">function</param>

6751

6752

6753

<insert>register_tick_function(callback function [,mixed arg]);</insert>

6754

<dialog title="Insert register_tick_function">register_tick_function(%0, %1);</dialog>

6755

6756

</function>

6757

6758

6759

De-register a function for execution on each tick

6760

</description>

6761

<param name="function_name" required="1" vallist="0" default="" type="string">function_name</param>

6762

6763

<insert>unregister_tick_function(string function_name);</insert>

6764

<dialog title="Insert unregister_tick_function">unregister_tick_function(%0);</dialog>

6765

6766

</function>

6767

</group>

6768

6769

6770

6771

Specify the character encoding in which the messages from the

6772

DOMAIN message catalog will be returned

6773

</description>

6774

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6775

<param name="codeset" required="1" vallist="0" default="" type="string">codeset</param>

6776

<return type="string">string</return>

6777

<insert>bind_textdomain_codeset(string domain, string codeset);</insert>

6778

<dialog title="Insert bind_textdomain_codeset">bind_textdomain_codeset(%0, %1);</dialog>

6779

6780

</function>

6781

6782

<description>Sets the path for a domain</description>

6783

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6784

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

6785

<return type="string">string</return>

6786

<insert>bindtextdomain(string domain, string directory);</insert>

6787

<dialog title="Insert bindtextdomain">bindtextdomain(%0, %1);</dialog>

6788

6789

</function>

6790

6791

<description>Overrides the domain for a single lookup</description>

6792

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6793

<param name="message" required="1" vallist="0" default="" type="string">message</param>

6794

<param name="category" required="1" vallist="0" default="" type="int">category</param>

6795

<return type="string">string</return>

6796

<insert>dcgettext(string domain, string message, int category);</insert>

6797

<dialog title="Insert dcgettext">dcgettext(%0, %1, %2);</dialog>

6798

6799

</function>

6800

6801

<description>Plural version of dcgettext</description>

6802

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6803

<param name="msgid1" required="1" vallist="0" default="" type="string">msgid1</param>

6804

<param name="msgid2" required="1" vallist="0" default="" type="string">msgid2</param>

6805

6806

<param name="category" required="1" vallist="0" default="" type="int">category</param>

6807

<return type="string">string</return>

6808

<insert>dcngettext(string domain, string msgid1, string msgid2, int n, int category);</insert>

6809

<dialog title="Insert dcngettext">dcngettext(%0, %1, %2, %3, %4);</dialog>

6810

6811

</function>

6812

6813

<description>Override the current domain</description>

6814

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6815

<param name="message" required="1" vallist="0" default="" type="string">message</param>

6816

<return type="string">string</return>

6817

<insert>dgettext(string domain, string message);</insert>

6818

<dialog title="Insert dgettext">dgettext(%0, %1);</dialog>

6819

6820

</function>

6821

6822

<description>Plural version of dgettext</description>

6823

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

6824

<param name="msgid1" required="1" vallist="0" default="" type="string">msgid1</param>

6825

<param name="msgid2" required="1" vallist="0" default="" type="string">msgid2</param>

6826

6827

<return type="string">string</return>

6828

<insert>dngettext(string domain, string msgid1, string msgid2, int n);</insert>

6829

<dialog title="Insert dngettext">dngettext(%0, %1, %2, %3);</dialog>

6830

6831

</function>

6832

6833

<description>Lookup a message in the current domain</description>

6834

<param name="message" required="1" vallist="0" default="" type="string">message</param>

6835

<return type="string">string</return>

6836

<insert>gettext(string message);</insert>

6837

<dialog title="Insert gettext">gettext(%0);</dialog>

6838

6839

</function>

6840

6841

<description>Plural version of gettext</description>

6842

<param name="msgid1" required="1" vallist="0" default="" type="string">msgid1</param>

6843

<param name="msgid2" required="1" vallist="0" default="" type="string">msgid2</param>

6844

6845

<return type="string">string</return>

6846

<insert>ngettext(string msgid1, string msgid2, int n);</insert>

6847

<dialog title="Insert ngettext">ngettext(%0, %1, %2);</dialog>

6848

6849

</function>

6850

6851

<description>Sets the default domain</description>

6852

<param name="text_domain" required="1" vallist="0" default="" type="string">text_domain</param>

6853

<return type="string">string</return>

6854

<insert>textdomain(string text_domain);</insert>

6855

<dialog title="Insert textdomain">textdomain(%0);</dialog>

6856

6857

</function>

6858

</group>

6859

6860

6861

<description>Absolute value</description>

6862

6863

<return type="resource">resource</return>

6864

<insert>gmp_abs(resource a);</insert>

6865

6866

6867

</function>

6868

6869

<description>Add numbers</description>

6870

6871

6872

<return type="resource">resource</return>

6873

<insert>gmp_add(resource a, resource b);</insert>

6874

6875

6876

</function>

6877

6878

<description>Logical AND</description>

6879

6880

6881

<return type="resource">resource</return>

6882

<insert>gmp_and(resource a, resource b);</insert>

6883

6884

6885

</function>

6886

6887

<description>Clear bit</description>

6888

6889

<param name="index" required="1" vallist="0" default="" type="int">index</param>

6890

<return type="resource">resource</return>

6891

<insert>gmp_clrbit(resource &a, int index);</insert>

6892

<dialog title="Insert gmp_clrbit">gmp_clrbit(%0, %1);</dialog>

6893

6894

</function>

6895

6896

<description>Compare numbers</description>

6897

6898

6899

6900

<insert>gmp_cmp(resource a, resource b);</insert>

6901

6902

6903

</function>

6904

6905

<description>Calculates one's complement of a</description>

6906

6907

<return type="resource">resource</return>

6908

<insert>gmp_com(resource a);</insert>

6909

6910

6911

</function>

6912

6913

<description>Divide numbers</description>

6914

6915

6916

<param name="round" required="0" vallist="0" default="" type="int">round</param>

6917

<return type="resource">resource</return>

6918

<insert>gmp_div_q(resource a, resource b [,int round]);</insert>

6919

6920

6921

</function>

6922

6923

<description>Divide numbers and get quotient and remainder</description>

6924

6925

6926

<param name="round" required="0" vallist="0" default="" type="int">round</param>

6927

<return type="array">array</return>

6928

<insert>gmp_div_qr(resource n, resource d [,int round]);</insert>

6929

6930

6931

</function>

6932

6933

<description>Remainder of the division of numbers</description>

6934

6935

6936

<param name="round" required="0" vallist="0" default="" type="int">round</param>

6937

<return type="resource">resource</return>

6938

<insert>gmp_div_r(resource n, resource d [,int round]);</insert>

6939

6940

6941

</function>

6942

6943

<description>Exact division of numbers</description>

6944

6945

6946

<return type="resource">resource</return>

6947

<insert>gmp_divexact(resource n, resource d);</insert>

6948

<dialog title="Insert gmp_divexact">gmp_divexact(%0, %1);</dialog>

6949

6950

</function>

6951

6952

<description>Factorial</description>

6953

6954

<return type="resource">resource</return>

6955

6956

6957

6958

</function>

6959

6960

<description>Calculate GCD</description>

6961

6962

6963

<return type="resource">resource</return>

6964

<insert>gmp_gcd(resource a, resource b);</insert>

6965

6966

6967

</function>

6968

6969

<description>Calculate GCD and multipliers</description>

6970

6971

6972

<return type="array">array</return>

6973

<insert>gmp_gcdext(resource a, resource b);</insert>

6974

<dialog title="Insert gmp_gcdext">gmp_gcdext(%0, %1);</dialog>

6975

6976

</function>

6977

6978

<description>Hamming distance</description>

6979

6980

6981

6982

<insert>gmp_hamdist(resource a, resource b);</insert>

6983

<dialog title="Insert gmp_hamdist">gmp_hamdist(%0, %1);</dialog>

6984

6985

</function>

6986

6987

<description>Create GMP number</description>

6988

<param name="number" required="1" vallist="0" default="" type="mixed">number</param>

6989

<return type="resource">resource</return>

6990

<insert>gmp_init(mixed number);</insert>

6991

6992

6993

</function>

6994

6995

<description>Convert GMP number to integer</description>

6996

<param name="gmpnumber" required="1" vallist="0" default="" type="resource">gmpnumber</param>

6997

6998

<insert>gmp_intval(resource gmpnumber);</insert>

6999

<dialog title="Insert gmp_intval">gmp_intval(%0);</dialog>

7000

7001

</function>

7002

7003

<description>Inverse by modulo</description>

7004

7005

7006

<return type="resource">resource</return>

7007

<insert>gmp_invert(resource a, resource b);</insert>

7008

<dialog title="Insert gmp_invert">gmp_invert(%0, %1);</dialog>

7009

7010

</function>

7011

7012

<description>Jacobi symbol</description>

7013

7014

7015

7016

<insert>gmp_jacobi(resource a, resource p);</insert>

7017

<dialog title="Insert gmp_jacobi">gmp_jacobi(%0, %1);</dialog>

7018

7019

</function>

7020

7021

<description>Legendre symbol</description>

7022

7023

7024

7025

<insert>gmp_legendre(resource a, resource p);</insert>

7026

<dialog title="Insert gmp_legendre">gmp_legendre(%0, %1);</dialog>

7027

7028

</function>

7029

7030

<description>Modulo operation</description>

7031

7032

7033

<return type="resource">resource</return>

7034

<insert>gmp_mod(resource n, resource d);</insert>

7035

7036

7037

</function>

7038

7039

<description>Multiply numbers</description>

7040

7041

7042

<return type="resource">resource</return>

7043

<insert>gmp_mul(resource a, resource b);</insert>

7044

7045

7046

</function>

7047

7048

<description>Negate number</description>

7049

7050

<return type="resource">resource</return>

7051

<insert>gmp_neg(resource a);</insert>

7052

7053

7054

</function>

7055

7056

<description>Logical OR</description>

7057

7058

7059

<return type="resource">resource</return>

7060

<insert>gmp_or(resource a, resource b);</insert>

7061

7062

7063

</function>

7064

7065

<description>Perfect square check</description>

7066

7067

7068

<insert>gmp_perfect_square(resource a);</insert>

7069

<dialog title="Insert gmp_perfect_square">gmp_perfect_square(%0);</dialog>

7070

7071

</function>

7072

7073

<description>Population count</description>

7074

7075

7076

<insert>gmp_popcount(resource a);</insert>

7077

<dialog title="Insert gmp_popcount">gmp_popcount(%0);</dialog>

7078

7079

</function>

7080

7081

<description>Raise number into power</description>

7082

7083

7084

<return type="resource">resource</return>

7085

<insert>gmp_pow(resource base, int exp);</insert>

7086

7087

7088

</function>

7089

7090

<description>Raise number into power with modulo</description>

7091

7092

7093

7094

<return type="resource">resource</return>

7095

<insert>gmp_powm(resource base, resource exp, resource mod);</insert>

7096

7097

7098

</function>

7099

7100

<description>Check if number is "probably prime"</description>

7101

7102

7103

7104

<insert>gmp_prob_prime(resource a [,int reps]);</insert>

7105

<dialog title="Insert gmp_prob_prime">gmp_prob_prime(%0, %1);</dialog>

7106

7107

</function>

7108

7109

<description>Random number</description>

7110

<param name="limiter" required="1" vallist="0" default="" type="int">limiter</param>

7111

<return type="resource">resource</return>

7112

<insert>gmp_random(int limiter);</insert>

7113

<dialog title="Insert gmp_random">gmp_random(%0);</dialog>

7114

7115

</function>

7116

7117

7118

7119

<param name="start" required="1" vallist="0" default="" type="int">start</param>

7120

7121

<insert>gmp_scan0(resource a, int start);</insert>

7122

7123

7124

</function>

7125

7126

7127

7128

<param name="start" required="1" vallist="0" default="" type="int">start</param>

7129

7130

<insert>gmp_scan1(resource a, int start);</insert>

7131

7132

7133

</function>

7134

7135

7136

7137

<param name="index" required="1" vallist="0" default="" type="int">index</param>

7138

<param name="set_clear" required="0" vallist="0" default="" type="bool">set_clear</param>

7139

<return type="resource">resource</return>

7140

<insert>gmp_setbit(resource &a, int index [,bool set_clear]);</insert>

7141

<dialog title="Insert gmp_setbit">gmp_setbit(%0, %1, %2);</dialog>

7142

7143

</function>

7144

7145

<description>Sign of number</description>

7146

7147

7148

<insert>gmp_sign(resource a);</insert>

7149

7150

7151

</function>

7152

7153

<description>Square root</description>

7154

7155

<return type="resource">resource</return>

7156

<insert>gmp_sqrt(resource a);</insert>

7157

7158

7159

</function>

7160

7161

<description>Square root with remainder</description>

7162

7163

<return type="array">array</return>

7164

<insert>gmp_sqrtrm(resource a);</insert>

7165

<dialog title="Insert gmp_sqrtrm">gmp_sqrtrm(%0);</dialog>

7166

7167

</function>

7168

7169

<description>Convert GMP number to string</description>

7170

<param name="gmpnumber" required="1" vallist="0" default="" type="resource">gmpnumber</param>

7171

7172

<return type="string">string</return>

7173

<insert>gmp_strval(resource gmpnumber [,int base]);</insert>

7174

<dialog title="Insert gmp_strval">gmp_strval(%0, %1);</dialog>

7175

7176

</function>

7177

7178

<description>Subtract numbers</description>

7179

7180

7181

<return type="resource">resource</return>

7182

<insert>gmp_sub(resource a, resource b);</insert>

7183

7184

7185

</function>

7186

7187

<description>Logical XOR</description>

7188

7189

7190

<return type="resource">resource</return>

7191

<insert>gmp_xor(resource a, resource b);</insert>

7192

7193

7194

</function>

7195

</group>

7196

7197

7198

<description>Send a raw HTTP header</description>

7199

<param name="string" required="1" vallist="0" default="" type="string">string</param>

7200

<param name="replace" required="0" vallist="0" default="" type="bool">replace</param>

7201

<param name="http_reponse_code" required="0" vallist="0" default="" type="int">http_reponse_code</param>

7202

7203

<insert>header(string string [,bool replace] [,int http_reponse_code]);</insert>

7204

<dialog title="Insert header">header(%0, %1, %2);</dialog>

7205

7206

</function>

7207

7208

<description>Checks if or where headers have been sent</description>

7209

7210

7211

7212

<insert>headers_sent([string &file] [,int &line]);</insert>

7213

<dialog title="Insert headers_sent">headers_sent(%0, %1);</dialog>

7214

7215

</function>

7216

7217

<description>Send a cookie</description>

7218

7219

<param name="value" required="0" vallist="0" default="" type="string">value</param>

7220

<param name="expire" required="0" vallist="0" default="" type="int">expire</param>

7221

7222

<param name="domain" required="0" vallist="0" default="" type="string">domain</param>

7223

<param name="secure" required="0" vallist="0" default="" type="int">secure</param>

7224

7225

<insert>setcookie(string name [,string value] [,int expire] [,string path] [,string domain] [,int secure]);</insert>

7226

<dialog title="Insert setcookie">setcookie(%0, %1, %2, %3, %4, %5);</dialog>

7227

7228

</function>

7229

</group>

7230

7231

7232

<description>convert attributes from object array to object record</description>

7233

<param name="object_array" required="1" vallist="0" default="" type="array">object_array</param>

7234

<return type="string">string</return>

7235

<insert>hw_Array2Objrec(array object_array);</insert>

7236

<dialog title="Insert hw_Array2Objrec">hw_Array2Objrec(%0);</dialog>

7237

7238

</function>

7239

7240

7241

Changes attributes of an object (obsolete)

7242

</description>

7243

7244

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

7245

<param name="attributes" required="1" vallist="0" default="" type="array">attributes</param>

7246

7247

<insert>hw_changeobject(int link, int objid, array attributes);</insert>

7248

<dialog title="Insert hw_changeobject">hw_changeobject(%0, %1, %2);</dialog>

7249

7250

</function>

7251

7252

<description>object ids of children</description>

7253

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7254

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7255

<return type="array">array</return>

7256

<insert>hw_Children(int connection, int objectID);</insert>

7257

<dialog title="Insert hw_Children">hw_Children(%0, %1);</dialog>

7258

7259

</function>

7260

7261

<description>object records of children</description>

7262

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7263

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7264

<return type="array">array</return>

7265

<insert>hw_ChildrenObj(int connection, int objectID);</insert>

7266

<dialog title="Insert hw_ChildrenObj">hw_ChildrenObj(%0, %1);</dialog>

7267

7268

</function>

7269

7270

<description>closes the Hyperwave connection</description>

7271

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7272

7273

<insert>hw_Close(int connection);</insert>

7274

<dialog title="Insert hw_Close">hw_Close(%0);</dialog>

7275

7276

</function>

7277

7278

<description>opens a connection</description>

7279

7280

7281

<param name="username" required="1" vallist="0" default="" type="string">username</param>

7282

<param name="password" required="1" vallist="0" default="" type="string">password</param>

7283

7284

<insert>hw_Connect(string host, int port, string username, string password);</insert>

7285

<dialog title="Insert hw_Connect">hw_Connect(%0, %1, %2, %3);</dialog>

7286

7287

</function>

7288

7289

7290

Prints information about the connection to Hyperwave server

7291

</description>

7292

7293

7294

<insert>hw_connection_info(int link);</insert>

7295

<dialog title="Insert hw_connection_info">hw_connection_info(%0);</dialog>

7296

7297

</function>

7298

7299

<description>Copies objects</description>

7300

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7301

<param name="object_id_array" required="1" vallist="0" default="" type="array">object_id_array</param>

7302

<param name="destination_id" required="1" vallist="0" default="" type="int">destination_id</param>

7303

7304

<insert>hw_cp(int connection, array object_id_array, int destination_id);</insert>

7305

7306

7307

</function>

7308

7309

<description>deletes object</description>

7310

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7311

<param name="object_to_delete" required="1" vallist="0" default="" type="int">object_to_delete</param>

7312

7313

<insert>hw_Deleteobject(int connection, int object_to_delete);</insert>

7314

<dialog title="Insert hw_Deleteobject">hw_Deleteobject(%0, %1);</dialog>

7315

7316

</function>

7317

7318

<description>object id object belonging to anchor</description>

7319

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7320

<param name="anchorID" required="1" vallist="0" default="" type="int">anchorID</param>

7321

7322

<insert>hw_DocByAnchor(int connection, int anchorID);</insert>

7323

<dialog title="Insert hw_DocByAnchor">hw_DocByAnchor(%0, %1);</dialog>

7324

7325

</function>

7326

7327

<description>object record object belonging to anchor</description>

7328

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7329

<param name="anchorID" required="1" vallist="0" default="" type="int">anchorID</param>

7330

<return type="string">string</return>

7331

<insert>hw_DocByAnchorObj(int connection, int anchorID);</insert>

7332

<dialog title="Insert hw_DocByAnchorObj">hw_DocByAnchorObj(%0, %1);</dialog>

7333

7334

</function>

7335

7336

<description>object record of hw_document</description>

7337

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7338

<return type="string">string</return>

7339

<insert>hw_Document_Attributes(int hw_document);</insert>

7340

<dialog title="Insert hw_Document_Attributes">hw_Document_Attributes(%0);</dialog>

7341

7342

</function>

7343

7344

<description>body tag of hw_document</description>

7345

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7346

<return type="string">string</return>

7347

<insert>hw_Document_BodyTag(int hw_document);</insert>

7348

<dialog title="Insert hw_Document_BodyTag">hw_Document_BodyTag(%0);</dialog>

7349

7350

</function>

7351

7352

<description>returns content of hw_document</description>

7353

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7354

<return type="string">string</return>

7355

<insert>hw_Document_Content(int hw_document);</insert>

7356

<dialog title="Insert hw_Document_Content">hw_Document_Content(%0);</dialog>

7357

7358

</function>

7359

7360

<description>sets/replaces content of hw_document</description>

7361

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7362

<param name="content" required="1" vallist="0" default="" type="string">content</param>

7363

<return type="string">string</return>

7364

<insert>hw_Document_SetContent(int hw_document, string content);</insert>

7365

<dialog title="Insert hw_Document_SetContent">hw_Document_SetContent(%0, %1);</dialog>

7366

7367

</function>

7368

7369

<description>size of hw_document</description>

7370

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7371

7372

<insert>hw_Document_Size(int hw_document);</insert>

7373

<dialog title="Insert hw_Document_Size">hw_Document_Size(%0);</dialog>

7374

7375

</function>

7376

7377

7378

Hyperwave dummy function

7379

</description>

7380

7381

7382

<param name="msgid" required="1" vallist="0" default="" type="int">msgid</param>

7383

<return type="string">string</return>

7384

<insert>hw_dummy(int link, int id, int msgid);</insert>

7385

<dialog title="Insert hw_dummy">hw_dummy(%0, %1, %2);</dialog>

7386

7387

</function>

7388

7389

<description>retrieve text document</description>

7390

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7391

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7392

7393

<insert>hw_EditText(int connection, int hw_document);</insert>

7394

<dialog title="Insert hw_EditText">hw_EditText(%0, %1);</dialog>

7395

7396

</function>

7397

7398

<description>error number</description>

7399

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7400

7401

<insert>hw_Error(int connection);</insert>

7402

<dialog title="Insert hw_Error">hw_Error(%0);</dialog>

7403

7404

</function>

7405

7406

<description>returns error message</description>

7407

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7408

<return type="string">string</return>

7409

<insert>hw_ErrorMsg(int connection);</insert>

7410

<dialog title="Insert hw_ErrorMsg">hw_ErrorMsg(%0);</dialog>

7411

7412

</function>

7413

7414

<description>frees hw_document</description>

7415

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7416

7417

<insert>hw_Free_Document(int hw_document);</insert>

7418

<dialog title="Insert hw_Free_Document">hw_Free_Document(%0);</dialog>

7419

7420

</function>

7421

7422

<description>object ids of anchors of document</description>

7423

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7424

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7425

<return type="array">array</return>

7426

<insert>hw_GetAnchors(int connection, int objectID);</insert>

7427

<dialog title="Insert hw_GetAnchors">hw_GetAnchors(%0, %1);</dialog>

7428

7429

</function>

7430

7431

<description>object records of anchors of document</description>

7432

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7433

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7434

<return type="array">array</return>

7435

<insert>hw_GetAnchorsObj(int connection, int objectID);</insert>

7436

<dialog title="Insert hw_GetAnchorsObj">hw_GetAnchorsObj(%0, %1);</dialog>

7437

7438

</function>

7439

7440

<description>return bject record and lock object</description>

7441

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7442

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7443

<return type="string">string</return>

7444

<insert>hw_GetAndLock(int connection, int objectID);</insert>

7445

<dialog title="Insert hw_GetAndLock">hw_GetAndLock(%0, %1);</dialog>

7446

7447

</function>

7448

7449

<description>object ids of child collections</description>

7450

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7451

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7452

<return type="array">array</return>

7453

<insert>hw_GetChildColl(int connection, int objectID);</insert>

7454

<dialog title="Insert hw_GetChildColl">hw_GetChildColl(%0, %1);</dialog>

7455

7456

</function>

7457

7458

<description>object records of child collections</description>

7459

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7460

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7461

<return type="array">array</return>

7462

<insert>hw_GetChildCollObj(int connection, int objectID);</insert>

7463

<dialog title="Insert hw_GetChildCollObj">hw_GetChildCollObj(%0, %1);</dialog>

7464

7465

</function>

7466

7467

<description>object ids of child documents of collection</description>

7468

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7469

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7470

<return type="array">array</return>

7471

<insert>hw_GetChildDocColl(int connection, int objectID);</insert>

7472

<dialog title="Insert hw_GetChildDocColl">hw_GetChildDocColl(%0, %1);</dialog>

7473

7474

</function>

7475

7476

<description>object records of child documents of collection</description>

7477

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7478

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7479

<return type="array">array</return>

7480

<insert>hw_GetChildDocCollObj(int connection, int objectID);</insert>

7481

<dialog title="Insert hw_GetChildDocCollObj">hw_GetChildDocCollObj(%0, %1);</dialog>

7482

7483

</function>

7484

7485

<description>object record</description>

7486

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7487

<param name="objectID" required="1" vallist="0" default="" type="mixed">objectID</param>

7488

<param name="query" required="1" vallist="0" default="" type="string">query</param>

7489

<return type="array">array</return>

7490

<insert>hw_GetObject(int connection, mixed objectID, string query);</insert>

7491

<dialog title="Insert hw_GetObject">hw_GetObject(%0, %1, %2);</dialog>

7492

7493

</function>

7494

7495

<description>search object</description>

7496

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7497

<param name="query" required="1" vallist="0" default="" type="string">query</param>

7498

7499

<return type="array">array</return>

7500

<insert>hw_GetObjectByQuery(int connection, string query, int max_hits);</insert>

7501

<dialog title="Insert hw_GetObjectByQuery">hw_GetObjectByQuery(%0, %1, %2);</dialog>

7502

7503

</function>

7504

7505

<description>search object in collection</description>

7506

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7507

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7508

<param name="query" required="1" vallist="0" default="" type="string">query</param>

7509

7510

<return type="array">array</return>

7511

<insert>hw_GetObjectByQueryColl(int connection, int objectID, string query, int max_hits);</insert>

7512

<dialog title="Insert hw_GetObjectByQueryColl">hw_GetObjectByQueryColl(%0, %1, %2, %3);</dialog>

7513

7514

</function>

7515

7516

<description>search object in collection</description>

7517

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7518

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7519

<param name="query" required="1" vallist="0" default="" type="string">query</param>

7520

7521

<return type="array">array</return>

7522

<insert>hw_GetObjectByQueryCollObj(int connection, int objectID, string query, int max_hits);</insert>

7523

<dialog title="Insert hw_GetObjectByQueryCollObj">hw_GetObjectByQueryCollObj(%0, %1, %2, %3);</dialog>

7524

7525

</function>

7526

7527

<description>search object</description>

7528

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7529

<param name="query" required="1" vallist="0" default="" type="string">query</param>

7530

7531

<return type="array">array</return>

7532

<insert>hw_GetObjectByQueryObj(int connection, string query, int max_hits);</insert>

7533

<dialog title="Insert hw_GetObjectByQueryObj">hw_GetObjectByQueryObj(%0, %1, %2);</dialog>

7534

7535

</function>

7536

7537

<description>object ids of parents</description>

7538

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7539

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7540

<return type="array">array</return>

7541

<insert>hw_GetParents(int connection, int objectID);</insert>

7542

<dialog title="Insert hw_GetParents">hw_GetParents(%0, %1);</dialog>

7543

7544

</function>

7545

7546

<description>object records of parents</description>

7547

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7548

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7549

<return type="array">array</return>

7550

<insert>hw_GetParentsObj(int connection, int objectID);</insert>

7551

<dialog title="Insert hw_GetParentsObj">hw_GetParentsObj(%0, %1);</dialog>

7552

7553

</function>

7554

7555

7556

Get link from source to dest relative to rootid

7557

</description>

7558

7559

<param name="rootid" required="1" vallist="0" default="" type="int">rootid</param>

7560

<param name="sourceid" required="1" vallist="0" default="" type="int">sourceid</param>

7561

<param name="destid" required="1" vallist="0" default="" type="int">destid</param>

7562

<return type="string">string</return>

7563

<insert>hw_getrellink(int link, int rootid, int sourceid, int destid);</insert>

7564

<dialog title="Insert hw_getrellink">hw_getrellink(%0, %1, %2, %3);</dialog>

7565

7566

</function>

7567

7568

<description>Gets a remote document</description>

7569

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7570

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7571

7572

<insert>hw_GetRemote(int connection, int objectID);</insert>

7573

<dialog title="Insert hw_GetRemote">hw_GetRemote(%0, %1);</dialog>

7574

7575

</function>

7576

7577

<description>Gets children of remote document</description>

7578

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7579

<param name="object_record" required="1" vallist="0" default="" type="string">object_record</param>

7580

7581

<insert>hw_getremotechildren(int connection, string object_record);</insert>

7582

<dialog title="Insert hw_getremotechildren">hw_getremotechildren(%0, %1);</dialog>

7583

7584

</function>

7585

7586

<description>Returns anchors pointing at object</description>

7587

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7588

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7589

<return type="array">array</return>

7590

<insert>hw_GetSrcByDestObj(int connection, int objectID);</insert>

7591

<dialog title="Insert hw_GetSrcByDestObj">hw_GetSrcByDestObj(%0, %1);</dialog>

7592

7593

</function>

7594

7595

<description>retrieve text document</description>

7596

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7597

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7598

<param name="

7599

rootID/prefix

7600

" required="0" vallist="0" default="" type="mixed">

7601

rootID/prefix

7602

</param>

7603

7604

<insert>hw_GetText(int connection, int objectID [,mixed

7605

rootID/prefix

7606

]);</insert>

7607

<dialog title="Insert hw_GetText">hw_GetText(%0, %1, %2);</dialog>

7608

7609

</function>

7610

7611

<description>name of currently logged in user</description>

7612

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7613

<return type="string">string</return>

7614

<insert>hw_getusername(int connection);</insert>

7615

<dialog title="Insert hw_getusername">hw_getusername(%0);</dialog>

7616

7617

</function>

7618

7619

<description>identifies as user</description>

7620

<param name="username" required="1" vallist="0" default="" type="string">username</param>

7621

<param name="password" required="1" vallist="0" default="" type="string">password</param>

7622

7623

<insert>hw_Identify(string username, string password);</insert>

7624

<dialog title="Insert hw_Identify">hw_Identify(%0, %1);</dialog>

7625

7626

</function>

7627

7628

<description>check if object ids in collections</description>

7629

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7630

<param name="object_id_array" required="1" vallist="0" default="" type="array">object_id_array</param>

7631

<param name="collection_id_array" required="1" vallist="0" default="" type="array">collection_id_array</param>

7632

<param name="return_collections" required="1" vallist="0" default="" type="int">return_collections</param>

7633

<return type="array">array</return>

7634

<insert>hw_InCollections(int connection, array object_id_array, array collection_id_array, int return_collections);</insert>

7635

<dialog title="Insert hw_InCollections">hw_InCollections(%0, %1, %2, %3);</dialog>

7636

7637

</function>

7638

7639

<description>info about connection</description>

7640

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7641

<return type="string">string</return>

7642

<insert>hw_Info(int connection);</insert>

7643

7644

7645

</function>

7646

7647

<description>insert collection</description>

7648

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7649

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7650

<param name="object_array" required="1" vallist="0" default="" type="array">object_array</param>

7651

7652

<insert>hw_InsColl(int connection, int objectID, array object_array);</insert>

7653

<dialog title="Insert hw_InsColl">hw_InsColl(%0, %1, %2);</dialog>

7654

7655

</function>

7656

7657

<description>insert document</description>

7658

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7659

<param name="parentID" required="1" vallist="0" default="" type="int">parentID</param>

7660

<param name="object_record" required="1" vallist="0" default="" type="string">object_record</param>

7661

7662

7663

<insert>hw_InsDoc(int connection, int parentID, string object_record, string text);</insert>

7664

<dialog title="Insert hw_InsDoc">hw_InsDoc(%0, %1, %2, %3);</dialog>

7665

7666

</function>

7667

7668

7669

Inserts only anchors into text

7670

</description>

7671

<param name="hwdoc" required="1" vallist="0" default="" type="int">hwdoc</param>

7672

<param name="anchorecs" required="1" vallist="0" default="" type="array">anchorecs</param>

7673

7674

<param name="urlprefixes" required="0" vallist="0" default="" type="array">urlprefixes</param>

7675

<return type="string">string</return>

7676

<insert>hw_insertanchors(int hwdoc, array anchorecs, array dest [,array urlprefixes]);</insert>

7677

<dialog title="Insert hw_insertanchors">hw_insertanchors(%0, %1, %2, %3);</dialog>

7678

7679

</function>

7680

7681

<description>upload any document</description>

7682

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7683

<param name="parent_id" required="1" vallist="0" default="" type="int">parent_id</param>

7684

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7685

7686

<insert>hw_InsertDocument(int connection, int parent_id, int hw_document);</insert>

7687

<dialog title="Insert hw_InsertDocument">hw_InsertDocument(%0, %1, %2);</dialog>

7688

7689

</function>

7690

7691

<description>inserts an object record</description>

7692

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7693

<param name="object_rec" required="1" vallist="0" default="" type="string">object_rec</param>

7694

<param name="parameter" required="1" vallist="0" default="" type="string">parameter</param>

7695

7696

<insert>hw_InsertObject(int connection, string object_rec, string parameter);</insert>

7697

<dialog title="Insert hw_InsertObject">hw_InsertObject(%0, %1, %2);</dialog>

7698

7699

</function>

7700

7701

<description>Maps global id on virtual local id</description>

7702

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7703

<param name="server_id" required="1" vallist="0" default="" type="int">server_id</param>

7704

<param name="object_id" required="1" vallist="0" default="" type="int">object_id</param>

7705

7706

<insert>hw_mapid(int connection, int server_id, int object_id);</insert>

7707

<dialog title="Insert hw_mapid">hw_mapid(%0, %1, %2);</dialog>

7708

7709

</function>

7710

7711

<description>modifies object record</description>

7712

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7713

<param name="object_to_change" required="1" vallist="0" default="" type="int">object_to_change</param>

7714

<param name="remove" required="1" vallist="0" default="" type="array">remove</param>

7715

7716

7717

7718

<insert>hw_Modifyobject(int connection, int object_to_change, array remove, array add, int mode);</insert>

7719

<dialog title="Insert hw_Modifyobject">hw_Modifyobject(%0, %1, %2, %3, %4);</dialog>

7720

7721

</function>

7722

7723

<description>Moves objects</description>

7724

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7725

<param name="object_id_array" required="1" vallist="0" default="" type="array">object_id_array</param>

7726

<param name="source_id" required="1" vallist="0" default="" type="int">source_id</param>

7727

<param name="destination_id" required="1" vallist="0" default="" type="int">destination_id</param>

7728

7729

<insert>hw_mv(int connection, array object_id_array, int source_id, int destination_id);</insert>

7730

7731

7732

</function>

7733

7734

<description>create new document</description>

7735

<param name="object_record" required="1" vallist="0" default="" type="string">object_record</param>

7736

<param name="document_data" required="1" vallist="0" default="" type="string">document_data</param>

7737

<param name="document_size" required="1" vallist="0" default="" type="int">document_size</param>

7738

7739

<insert>hw_New_Document(string object_record, string document_data, int document_size);</insert>

7740

<dialog title="Insert hw_New_Document">hw_New_Document(%0, %1, %2);</dialog>

7741

7742

</function>

7743

7744

<description>Convert attributes from object record to object array</description>

7745

<param name="object_record" required="1" vallist="0" default="" type="string">object_record</param>

7746

<param name="

7747

format

7748

" required="0" vallist="0" default="" type="array">

7749

format

7750

</param>

7751

<return type="array">array</return>

7752

<insert>hw_objrec2array(string object_record [,array

7753

format

7754

]);</insert>

7755

<dialog title="Insert hw_objrec2array">hw_objrec2array(%0, %1);</dialog>

7756

7757

</function>

7758

7759

<description>prints hw_document</description>

7760

<param name="hw_document" required="1" vallist="0" default="" type="int">hw_document</param>

7761

7762

<insert>hw_Output_Document(int hw_document);</insert>

7763

<dialog title="Insert hw_Output_Document">hw_Output_Document(%0);</dialog>

7764

7765

</function>

7766

7767

<description>make a persistent database connection</description>

7768

7769

7770

<param name="username" required="1" vallist="0" default="" type="string">username</param>

7771

<param name="password" required="1" vallist="0" default="" type="string">password</param>

7772

7773

<insert>hw_pConnect(string host, int port, string username, string password);</insert>

7774

<dialog title="Insert hw_pConnect">hw_pConnect(%0, %1, %2, %3);</dialog>

7775

7776

</function>

7777

7778

<description>retrieve any document</description>

7779

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7780

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7781

7782

<insert>hw_PipeDocument(int connection, int objectID);</insert>

7783

<dialog title="Insert hw_PipeDocument">hw_PipeDocument(%0, %1);</dialog>

7784

7785

</function>

7786

7787

<description>root object id</description>

7788

7789

7790

7791

7792

</function>

7793

7794

7795

Set the id to which links are calculated

7796

</description>

7797

7798

<param name="rootid" required="1" vallist="0" default="" type="int">rootid</param>

7799

7800

<insert>hw_setlinkroot(int link, int rootid);</insert>

7801

<dialog title="Insert hw_setlinkroot">hw_setlinkroot(%0, %1);</dialog>

7802

7803

</function>

7804

7805

7806

Returns status string

7807

</description>

7808

7809

<return type="string">string</return>

7810

7811

7812

7813

</function>

7814

7815

<description>unlock object</description>

7816

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7817

<param name="objectID" required="1" vallist="0" default="" type="int">objectID</param>

7818

7819

<insert>hw_Unlock(int connection, int objectID);</insert>

7820

<dialog title="Insert hw_Unlock">hw_Unlock(%0, %1);</dialog>

7821

7822

</function>

7823

7824

<description>List of currently logged in users</description>

7825

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

7826

7827

<insert>hw_Who(int connection);</insert>

7828

7829

7830

</function>

7831

</group>

7832

7833

7834

<description>Returns key of the attribute</description>

7835

<return type="string">string</return>

7836

<insert>hw_api_attribute->key();</insert>

7837

<dialog title="Insert hw_api_attribute->key">hw_api_attribute->key();</dialog>

7838

7839

</function>

7840

<function name="hw_api_attribute->langdepvalue">

7841

<description>Returns value for a given language</description>

7842

<param name="language" required="1" vallist="0" default="" type="string">language</param>

7843

<return type="string">string</return>

7844

<insert>hw_api_attribute->langdepvalue(string language);</insert>

7845

<dialog title="Insert hw_api_attribute->langdepvalue">hw_api_attribute->langdepvalue(%0);</dialog>

7846

7847

</function>

7848

<function name="hw_api_attribute->value">

7849

<description>Returns value of the attribute</description>

7850

<return type="string">string</return>

7851

<insert>hw_api_attribute->value();</insert>

7852

<dialog title="Insert hw_api_attribute->value">hw_api_attribute->value();</dialog>

7853

7854

</function>

7855

<function name="hw_api_attribute->values">

7856

<description>Returns all values of the attribute</description>

7857

<return type="array">array</return>

7858

<insert>hw_api_attribute->values();</insert>

7859

<dialog title="Insert hw_api_attribute->values">hw_api_attribute->values();</dialog>

7860

7861

</function>

7862

7863

<description>Creates instance of class hw_api_attribute</description>

7864

7865

<param name="value" required="0" vallist="0" default="" type="string">value</param>

7866

<return type="object">object</return>

7867

<insert>hw_api_attribute([string name] [,string value]);</insert>

7868

<dialog title="Insert hw_api_attribute">hw_api_attribute(%0, %1);</dialog>

7869

7870

</function>

7871

<function name="hw_api->checkin">

7872

<description>Checks in an object</description>

7873

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7874

<return type="object">object</return>

7875

<insert>hw_api->checkin(array parameter);</insert>

7876

<dialog title="Insert hw_api->checkin">hw_api->checkin(%0);</dialog>

7877

7878

</function>

7879

<function name="hw_api->checkout">

7880

<description>Checks out an object</description>

7881

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7882

<return type="object">object</return>

7883

<insert>hw_api->checkout(array parameter);</insert>

7884

<dialog title="Insert hw_api->checkout">hw_api->checkout(%0);</dialog>

7885

7886

</function>

7887

<function name="hw_api->children">

7888

<description>Returns children of an object</description>

7889

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7890

<return type="array">array</return>

7891

<insert>hw_api->children(array parameter);</insert>

7892

<dialog title="Insert hw_api->children">hw_api->children(%0);</dialog>

7893

7894

</function>

7895

<function name="hw_api_content->mimetype">

7896

<description>Returns mimetype</description>

7897

<return type="string">string</return>

7898

<insert>hw_api_content->mimetype();</insert>

7899

<dialog title="Insert hw_api_content->mimetype">hw_api_content->mimetype();</dialog>

7900

7901

</function>

7902

7903

<description>Read content</description>

7904

<param name="buffer" required="1" vallist="0" default="" type="string">buffer</param>

7905

7906

<return type="string">string</return>

7907

<insert>hw_api_content->read(string buffer, integer len);</insert>

7908

<dialog title="Insert hw_api_content->read">hw_api_content->read(%0, %1);</dialog>

7909

7910

</function>

7911

<function name="hw_api->content">

7912

<description>Returns content of an object</description>

7913

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7914

<return type="object">object</return>

7915

<insert>hw_api->content(array parameter);</insert>

7916

<dialog title="Insert hw_api->content">hw_api->content(%0);</dialog>

7917

7918

</function>

7919

7920

<description>Copies physically</description>

7921

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7922

<return type="object">object</return>

7923

<insert>hw_api->copy(array parameter);</insert>

7924

7925

7926

</function>

7927

<function name="hw_api->dbstat">

7928

<description>Returns statistics about database server</description>

7929

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7930

<return type="object">object</return>

7931

<insert>hw_api->dbstat(array parameter);</insert>

7932

<dialog title="Insert hw_api->dbstat">hw_api->dbstat(%0);</dialog>

7933

7934

</function>

7935

<function name="hw_api->dcstat">

7936

<description>Returns statistics about document cache server</description>

7937

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7938

<return type="object">object</return>

7939

<insert>hw_api->dcstat(array parameter);</insert>

7940

<dialog title="Insert hw_api->dcstat">hw_api->dcstat(%0);</dialog>

7941

7942

</function>

7943

<function name="hw_api->dstanchors">

7944

<description>Returns a list of all destination anchors</description>

7945

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7946

<return type="object">object</return>

7947

<insert>hw_api->dstanchors(array parameter);</insert>

7948

<dialog title="Insert hw_api->dstanchors">hw_api->dstanchors(%0);</dialog>

7949

7950

</function>

7951

<function name="hw_api->dstofsrcanchors">

7952

<description>Returns destination of a source anchor</description>

7953

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7954

<return type="object">object</return>

7955

<insert>hw_api->dstofsrcanchors(array parameter);</insert>

7956

<dialog title="Insert hw_api->dstofsrcanchors">hw_api->dstofsrcanchors(%0);</dialog>

7957

7958

</function>

7959

<function name="hw_api_error->count">

7960

<description>Returns number of reasons</description>

7961

7962

<insert>hw_api_error->count();</insert>

7963

<dialog title="Insert hw_api_error->count">hw_api_error->count();</dialog>

7964

7965

</function>

7966

<function name="hw_api_error->reason">

7967

<description>Returns reason of error</description>

7968

<return type="object">object</return>

7969

<insert>hw_api_error->reason();</insert>

7970

<dialog title="Insert hw_api_error->reason">hw_api_error->reason();</dialog>

7971

7972

</function>

7973

7974

<description>Search for objects</description>

7975

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7976

<return type="array">array</return>

7977

<insert>hw_api->find(array parameter);</insert>

7978

7979

7980

</function>

7981

<function name="hw_api->ftstat">

7982

<description>Returns statistics about fulltext server</description>

7983

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

7984

<return type="object">object</return>

7985

<insert>hw_api->ftstat(array parameter);</insert>

7986

<dialog title="Insert hw_api->ftstat">hw_api->ftstat(%0);</dialog>

7987

7988

</function>

7989

7990

<description>Returns object of class hw_api</description>

7991

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

7992

7993

<return type="object">object</return>

7994

<insert>hwapi_hgcsp(string hostname [,int port]);</insert>

7995

<dialog title="Insert hwapi_hgcsp">hwapi_hgcsp(%0, %1);</dialog>

7996

7997

</function>

7998

<function name="hw_api->hwstat">

7999

<description>Returns statistics about Hyperwave server</description>

8000

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8001

<return type="object">object</return>

8002

<insert>hw_api->hwstat(array parameter);</insert>

8003

<dialog title="Insert hw_api->hwstat">hw_api->hwstat(%0);</dialog>

8004

8005

</function>

8006

<function name="hw_api->identify">

8007

<description>Log into Hyperwave Server</description>

8008

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8009

<return type="object">object</return>

8010

<insert>hw_api->identify(array parameter);</insert>

8011

<dialog title="Insert hw_api->identify">hw_api->identify(%0);</dialog>

8012

8013

</function>

8014

8015

<description>Returns information about server configuration</description>

8016

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8017

<return type="object">object</return>

8018

<insert>hw_api->info(array parameter);</insert>

8019

8020

8021

</function>

8022

<function name="hw_api->insert">

8023

<description>Inserts a new object</description>

8024

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8025

<return type="object">object</return>

8026

<insert>hw_api->insert(array parameter);</insert>

8027

<dialog title="Insert hw_api->insert">hw_api->insert(%0);</dialog>

8028

8029

</function>

8030

<function name="hw_api->insertanchor">

8031

<description>Inserts a new object of type anchor</description>

8032

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8033

<return type="object">object</return>

8034

<insert>hw_api->insertanchor(array parameter);</insert>

8035

<dialog title="Insert hw_api->insertanchor">hw_api->insertanchor(%0);</dialog>

8036

8037

</function>

8038

<function name="hw_api->insertcollection">

8039

<description>Inserts a new object of type collection</description>

8040

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8041

<return type="object">object</return>

8042

<insert>hw_api->insertcollection(array parameter);</insert>

8043

<dialog title="Insert hw_api->insertcollection">hw_api->insertcollection(%0);</dialog>

8044

8045

</function>

8046

<function name="hw_api->insertdocument">

8047

<description>Inserts a new object of type document</description>

8048

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8049

<return type="object">object</return>

8050

<insert>hw_api->insertdocument(array parameter);</insert>

8051

<dialog title="Insert hw_api->insertdocument">hw_api->insertdocument(%0);</dialog>

8052

8053

</function>

8054

8055

<description>Creates a link to an object</description>

8056

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8057

<return type="object">object</return>

8058

<insert>hw_api->link(array parameter);</insert>

8059

8060

8061

</function>

8062

8063

<description>Locks an object</description>

8064

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8065

<return type="object">object</return>

8066

<insert>hw_api->lock(array parameter);</insert>

8067

8068

8069

</function>

8070

8071

<description>Moves object between collections</description>

8072

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8073

<return type="object">object</return>

8074

<insert>hw_api->move(array parameter);</insert>

8075

8076

8077

</function>

8078

8079

<description>Create new instance of class hw_api_content</description>

8080

<param name="content" required="1" vallist="0" default="" type="string">content</param>

8081

<param name="mimetype" required="1" vallist="0" default="" type="string">mimetype</param>

8082

<return type="string">string</return>

8083

<insert>hw_api_content(string content, string mimetype);</insert>

8084

<dialog title="Insert hw_api_content">hw_api_content(%0, %1);</dialog>

8085

8086

</function>

8087

<function name="hw_api_object->assign">

8088

<description>Clones object</description>

8089

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8090

<return type="object">object</return>

8091

<insert>hw_api_object->assign(array parameter);</insert>

8092

<dialog title="Insert hw_api_object->assign">hw_api_object->assign(%0);</dialog>

8093

8094

</function>

8095

<function name="hw_api_object->attreditable">

8096

<description>Checks whether an attribute is editable</description>

8097

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8098

8099

<insert>hw_api_object->attreditable(array parameter);</insert>

8100

<dialog title="Insert hw_api_object->attreditable">hw_api_object->attreditable(%0);</dialog>

8101

8102

</function>

8103

<function name="hw_api_object->count">

8104

<description>Returns number of attributes</description>

8105

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8106

8107

<insert>hw_api_object->count(array parameter);</insert>

8108

<dialog title="Insert hw_api_object->count">hw_api_object->count(%0);</dialog>

8109

8110

</function>

8111

<function name="hw_api_object->insert">

8112

<description>Inserts new attribute</description>

8113

<param name="attribute" required="1" vallist="0" default="" type="object">attribute</param>

8114

8115

<insert>hw_api_object->insert(object attribute);</insert>

8116

<dialog title="Insert hw_api_object->insert">hw_api_object->insert(%0);</dialog>

8117

8118

</function>

8119

8120

<description>Creates a new instance of class hw_api_object</description>

8121

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8122

<return type="object">object</return>

8123

<insert>hw_api_object(array parameter);</insert>

8124

<dialog title="Insert hw_api_object">hw_api_object(%0);</dialog>

8125

8126

</function>

8127

<function name="hw_api_object->remove">

8128

<description>Removes attribute</description>

8129

8130

8131

<insert>hw_api_object->remove(string name);</insert>

8132

<dialog title="Insert hw_api_object->remove">hw_api_object->remove(%0);</dialog>

8133

8134

</function>

8135

<function name="hw_api_object->title">

8136

<description>Returns the title attribute</description>

8137

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8138

<return type="string">string</return>

8139

<insert>hw_api_object->title(array parameter);</insert>

8140

<dialog title="Insert hw_api_object->title">hw_api_object->title(%0);</dialog>

8141

8142

</function>

8143

<function name="hw_api_object->value">

8144

<description>Returns value of attribute</description>

8145

8146

<return type="string">string</return>

8147

<insert>hw_api_object->value(string name);</insert>

8148

<dialog title="Insert hw_api_object->value">hw_api_object->value(%0);</dialog>

8149

8150

</function>

8151

<function name="hw_api->object">

8152

<description>Retrieve attribute information</description>

8153

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8154

<return type="object">object</return>

8155

<insert>hw_api->object(array parameter);</insert>

8156

<dialog title="Insert hw_api->object">hw_api->object(%0);</dialog>

8157

8158

</function>

8159

<function name="hw_api->objectbyanchor">

8160

<description>Returns the object an anchor belongs to</description>

8161

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8162

<return type="object">object</return>

8163

<insert>hw_api->objectbyanchor(array parameter);</insert>

8164

<dialog title="Insert hw_api->objectbyanchor">hw_api->objectbyanchor(%0);</dialog>

8165

8166

</function>

8167

<function name="hw_api->parents">

8168

<description>Returns parents of an object</description>

8169

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8170

<return type="array">array</return>

8171

<insert>hw_api->parents(array parameter);</insert>

8172

<dialog title="Insert hw_api->parents">hw_api->parents(%0);</dialog>

8173

8174

</function>

8175

<function name="hw_api_reason->description">

8176

<description>Returns description of reason</description>

8177

<return type="string">string</return>

8178

<insert>hw_api_reason->description();</insert>

8179

<dialog title="Insert hw_api_reason->description">hw_api_reason->description();</dialog>

8180

8181

</function>

8182

8183

<description>Returns type of reason</description>

8184

<return type="object">object</return>

8185

<insert>hw_api_reason->type();</insert>

8186

<dialog title="Insert hw_api_reason->type">hw_api_reason->type();</dialog>

8187

8188

</function>

8189

<function name="hw_api->remove">

8190

<description>Delete an object</description>

8191

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8192

<return type="object">object</return>

8193

<insert>hw_api->remove(array parameter);</insert>

8194

<dialog title="Insert hw_api->remove">hw_api->remove(%0);</dialog>

8195

8196

</function>

8197

<function name="hw_api->replace">

8198

<description>Replaces an object</description>

8199

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8200

<return type="object">object</return>

8201

<insert>hw_api->replace(array parameter);</insert>

8202

<dialog title="Insert hw_api->replace">hw_api->replace(%0);</dialog>

8203

8204

</function>

8205

<function name="hw_api->setcommitedversion">

8206

<description>Commits version other than last version</description>

8207

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8208

<return type="object">object</return>

8209

<insert>hw_api->setcommitedversion(array parameter);</insert>

8210

<dialog title="Insert hw_api->setcommitedversion">hw_api->setcommitedversion(%0);</dialog>

8211

8212

</function>

8213

<function name="hw_api->srcanchors">

8214

<description>Returns a list of all source anchors</description>

8215

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8216

<return type="object">object</return>

8217

<insert>hw_api->srcanchors(array parameter);</insert>

8218

<dialog title="Insert hw_api->srcanchors">hw_api->srcanchors(%0);</dialog>

8219

8220

</function>

8221

<function name="hw_api->srcsofdst">

8222

<description>Returns source of a destination object</description>

8223

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8224

<return type="object">object</return>

8225

<insert>hw_api->srcsofdst(array parameter);</insert>

8226

<dialog title="Insert hw_api->srcsofdst">hw_api->srcsofdst(%0);</dialog>

8227

8228

</function>

8229

<function name="hw_api->unlock">

8230

<description>Unlocks a locked object</description>

8231

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8232

<return type="object">object</return>

8233

<insert>hw_api->unlock(array parameter);</insert>

8234

<dialog title="Insert hw_api->unlock">hw_api->unlock(%0);</dialog>

8235

8236

</function>

8237

8238

<description>Returns the own user object</description>

8239

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8240

<return type="object">object</return>

8241

<insert>hw_api->user(array parameter);</insert>

8242

8243

8244

</function>

8245

<function name="hw_api->userlist">

8246

<description>Returns a list of all logged in users</description>

8247

<param name="parameter" required="1" vallist="0" default="" type="array">parameter</param>

8248

<return type="object">object</return>

8249

<insert>hw_api->userlist(array parameter);</insert>

8250

<dialog title="Insert hw_api->userlist">hw_api->userlist(%0);</dialog>

8251

8252

</function>

8253

</group>

8254

8255

8256

8257

Add data into created blob

8258

</description>

8259

8260

8261

8262

<insert>ibase_blob_add(int blob_id, string data);</insert>

8263

<dialog title="Insert ibase_blob_add">ibase_blob_add(%0, %1);</dialog>

8264

8265

</function>

8266

8267

8268

Cancel creating blob

8269

</description>

8270

8271

8272

<insert>ibase_blob_cancel(int blob_id);</insert>

8273

<dialog title="Insert ibase_blob_cancel">ibase_blob_cancel(%0);</dialog>

8274

8275

</function>

8276

8277

8278

Close blob

8279

</description>

8280

8281

8282

<insert>ibase_blob_close(int blob_id);</insert>

8283

<dialog title="Insert ibase_blob_close">ibase_blob_close(%0);</dialog>

8284

8285

</function>

8286

8287

8288

Create blob for adding data

8289

</description>

8290

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8291

8292

<insert>ibase_blob_create([int link_identifier]);</insert>

8293

<dialog title="Insert ibase_blob_create">ibase_blob_create(%0);</dialog>

8294

8295

</function>

8296

8297

8298

Output blob contents to browser

8299

</description>

8300

8301

8302

<insert>ibase_blob_echo(string blob_id_str);</insert>

8303

<dialog title="Insert ibase_blob_echo">ibase_blob_echo(%0);</dialog>

8304

8305

</function>

8306

8307

8308

Get len bytes data from open blob

8309

</description>

8310

8311

8312

<return type="string">string</return>

8313

<insert>ibase_blob_get(int blob_id, int len);</insert>

8314

<dialog title="Insert ibase_blob_get">ibase_blob_get(%0, %1);</dialog>

8315

8316

</function>

8317

8318

8319

Create blob, copy file in it, and close it

8320

</description>

8321

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8322

8323

<return type="string">string</return>

8324

<insert>ibase_blob_import([int link_identifier], int file_id);</insert>

8325

<dialog title="Insert ibase_blob_import">ibase_blob_import(%0, %1);</dialog>

8326

8327

</function>

8328

8329

8330

Return blob length and other useful info

8331

</description>

8332

8333

<return type="object">object</return>

8334

<insert>ibase_blob_info(string blob_id_str);</insert>

8335

<dialog title="Insert ibase_blob_info">ibase_blob_info(%0);</dialog>

8336

8337

</function>

8338

8339

8340

Open blob for retrieving data parts

8341

</description>

8342

8343

8344

<insert>ibase_blob_open(string blob_id);</insert>

8345

<dialog title="Insert ibase_blob_open">ibase_blob_open(%0);</dialog>

8346

8347

</function>

8348

8349

8350

Close a connection to an InterBase database

8351

</description>

8352

<param name="connection_id" required="0" vallist="0" default="" type="int">connection_id</param>

8353

8354

<insert>ibase_close([int connection_id]);</insert>

8355

<dialog title="Insert ibase_close">ibase_close(%0);</dialog>

8356

8357

</function>

8358

8359

<description>Commit a transaction</description>

8360

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8361

<param name="trans_number" required="1" vallist="0" default="" type="int">trans_number</param>

8362

8363

<insert>ibase_commit([int link_identifier], int trans_number);</insert>

8364

<dialog title="Insert ibase_commit">ibase_commit(%0, %1);</dialog>

8365

8366

</function>

8367

8368

8369

Open a connection to an InterBase database

8370

</description>

8371

<param name="database" required="1" vallist="0" default="" type="string">database</param>

8372

<param name="username" required="0" vallist="0" default="" type="string">username</param>

8373

<param name="password" required="0" vallist="0" default="" type="string">password</param>

8374

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

8375

<param name="buffers" required="0" vallist="0" default="" type="int">buffers</param>

8376

<param name="dialect" required="0" vallist="0" default="" type="int">dialect</param>

8377

8378

8379

<insert>ibase_connect(string database [,string username] [,string password] [,string charset] [,int buffers] [,int dialect] [,string role]);</insert>

8380

<dialog title="Insert ibase_connect">ibase_connect(%0, %1, %2, %3, %4, %5, %6);</dialog>

8381

8382

</function>

8383

8384

8385

Returns error messages

8386

</description>

8387

<return type="string">string</return>

8388

<insert>ibase_errmsg();</insert>

8389

<dialog title="Insert ibase_errmsg">ibase_errmsg();</dialog>

8390

8391

</function>

8392

8393

<description>Execute a previously prepared query</description>

8394

<param name="query" required="1" vallist="0" default="" type="int">query</param>

8395

8396

8397

<insert>ibase_execute(int query [,int bind_args]);</insert>

8398

<dialog title="Insert ibase_execute">ibase_execute(%0, %1);</dialog>

8399

8400

</function>

8401

8402

<description>Get an object from a InterBase database</description>

8403

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8404

<return type="object">object</return>

8405

<insert>ibase_fetch_object(int result_id);</insert>

8406

<dialog title="Insert ibase_fetch_object">ibase_fetch_object(%0);</dialog>

8407

8408

</function>

8409

8410

<description>Fetch a row from an InterBase database</description>

8411

<param name="result_identifier" required="1" vallist="0" default="" type="int">result_identifier</param>

8412

<return type="array">array</return>

8413

<insert>ibase_fetch_row(int result_identifier);</insert>

8414

<dialog title="Insert ibase_fetch_row">ibase_fetch_row(%0);</dialog>

8415

8416

</function>

8417

8418

8419

Get information about a field

8420

</description>

8421

<param name="result" required="1" vallist="0" default="" type="int">result</param>

8422

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

8423

<return type="array">array</return>

8424

<insert>ibase_field_info(int result, int field_number);</insert>

8425

<dialog title="Insert ibase_field_info">ibase_field_info(%0, %1);</dialog>

8426

8427

</function>

8428

8429

8430

Free memory allocated by a prepared query

8431

</description>

8432

<param name="query" required="1" vallist="0" default="" type="int">query</param>

8433

8434

<insert>ibase_free_query(int query);</insert>

8435

<dialog title="Insert ibase_free_query">ibase_free_query(%0);</dialog>

8436

8437

</function>

8438

8439

<description>Free a result set</description>

8440

<param name="result_identifier" required="1" vallist="0" default="" type="int">result_identifier</param>

8441

8442

<insert>ibase_free_result(int result_identifier);</insert>

8443

<dialog title="Insert ibase_free_result">ibase_free_result(%0);</dialog>

8444

8445

</function>

8446

8447

8448

Get the number of fields in a result set

8449

</description>

8450

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8451

8452

<insert>ibase_num_fields(int result_id);</insert>

8453

<dialog title="Insert ibase_num_fields">ibase_num_fields(%0);</dialog>

8454

8455

</function>

8456

8457

8458

Creates an persistent connection to an InterBase database

8459

</description>

8460

<param name="database" required="1" vallist="0" default="" type="string">database</param>

8461

<param name="username" required="0" vallist="0" default="" type="string">username</param>

8462

<param name="password" required="0" vallist="0" default="" type="string">password</param>

8463

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

8464

<param name="buffers" required="0" vallist="0" default="" type="int">buffers</param>

8465

<param name="dialect" required="0" vallist="0" default="" type="int">dialect</param>

8466

8467

8468

<insert>ibase_pconnect(string database [,string username] [,string password] [,string charset] [,int buffers] [,int dialect] [,string role]);</insert>

8469

<dialog title="Insert ibase_pconnect">ibase_pconnect(%0, %1, %2, %3, %4, %5, %6);</dialog>

8470

8471

</function>

8472

8473

8474

Prepare a query for later binding of parameter placeholders and

8475

execution

8476

</description>

8477

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8478

<param name="query" required="1" vallist="0" default="" type="string">query</param>

8479

8480

<insert>ibase_prepare([int link_identifier], string query);</insert>

8481

<dialog title="Insert ibase_prepare">ibase_prepare(%0, %1);</dialog>

8482

8483

</function>

8484

8485

<description>Execute a query on an InterBase database</description>

8486

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8487

<param name="query" required="1" vallist="0" default="" type="string">query</param>

8488

8489

8490

<insert>ibase_query([int link_identifier], string query [,int bind_args]);</insert>

8491

<dialog title="Insert ibase_query">ibase_query(%0, %1, %2);</dialog>

8492

8493

</function>

8494

8495

<description>Rolls back a transaction</description>

8496

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8497

<param name="trans_number" required="1" vallist="0" default="" type="int">trans_number</param>

8498

8499

<insert>ibase_rollback([int link_identifier], int trans_number);</insert>

8500

<dialog title="Insert ibase_rollback">ibase_rollback(%0, %1);</dialog>

8501

8502

</function>

8503

8504

8505

Sets the format of timestamp, date and time type columns returned from queries

8506

</description>

8507

<param name="format" required="1" vallist="0" default="" type="string">format</param>

8508

<param name="columntype" required="0" vallist="0" default="" type="int">columntype</param>

8509

8510

<insert>ibase_timefmt(string format [,int columntype]);</insert>

8511

<dialog title="Insert ibase_timefmt">ibase_timefmt(%0, %1);</dialog>

8512

8513

</function>

8514

8515

<description>Begin a transaction</description>

8516

<param name="trans_args" required="0" vallist="0" default="" type="int">trans_args</param>

8517

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8518

8519

<insert>ibase_trans([int trans_args] [,int link_identifier]);</insert>

8520

<dialog title="Insert ibase_trans">ibase_trans(%0, %1);</dialog>

8521

8522

</function>

8523

</group>

8524

8525

8526

<description>Close an ICAP stream</description>

8527

<param name="icap_stream" required="1" vallist="0" default="" type="int">icap_stream</param>

8528

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

8529

8530

<insert>icap_close(int icap_stream [,int flags]);</insert>

8531

<dialog title="Insert icap_close">icap_close(%0, %1);</dialog>

8532

8533

</function>

8534

8535

8536

Create a new calendar

8537

</description>

8538

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8539

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

8540

<return type="string">string</return>

8541

<insert>icap_create_calendar(int stream_id, string calendar);</insert>

8542

<dialog title="Insert icap_create_calendar">icap_create_calendar(%0, %1);</dialog>

8543

8544

</function>

8545

8546

8547

Delete a calendar

8548

</description>

8549

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8550

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

8551

<return type="string">string</return>

8552

<insert>icap_delete_calendar(int stream_id, string calendar);</insert>

8553

<dialog title="Insert icap_delete_calendar">icap_delete_calendar(%0, %1);</dialog>

8554

8555

</function>

8556

8557

<description>Delete an event from an ICAP calendar</description>

8558

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8559

8560

<return type="string">string</return>

8561

<insert>icap_delete_event(int stream_id, int uid);</insert>

8562

<dialog title="Insert icap_delete_event">icap_delete_event(%0, %1);</dialog>

8563

8564

</function>

8565

8566

<description>Fetches an event from the calendar stream/</description>

8567

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8568

<param name="event_id" required="1" vallist="0" default="" type="int">event_id</param>

8569

<param name="options" required="0" vallist="0" default="" type="int">options</param>

8570

8571

<insert>icap_fetch_event(int stream_id, int event_id [,int options]);</insert>

8572

<dialog title="Insert icap_fetch_event">icap_fetch_event(%0, %1, %2);</dialog>

8573

8574

</function>

8575

8576

8577

Return a list of events that has an alarm triggered at the given

8578

datetime

8579

</description>

8580

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8581

8582

8583

8584

<insert>icap_list_alarms(int stream_id, array date, array time);</insert>

8585

<dialog title="Insert icap_list_alarms">icap_list_alarms(%0, %1, %2);</dialog>

8586

8587

</function>

8588

8589

8590

Return a list of events between two given datetimes

8591

</description>

8592

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8593

<param name="begin_date" required="1" vallist="0" default="" type="int">begin_date</param>

8594

8595

<return type="array">array</return>

8596

<insert>icap_list_events(int stream_id, int begin_date [,int end_date]);</insert>

8597

<dialog title="Insert icap_list_events">icap_list_events(%0, %1, %2);</dialog>

8598

8599

</function>

8600

8601

<description>Opens up an ICAP connection</description>

8602

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

8603

<param name="username" required="1" vallist="0" default="" type="string">username</param>

8604

<param name="password" required="1" vallist="0" default="" type="string">password</param>

8605

<param name="options" required="1" vallist="0" default="" type="string">options</param>

8606

<return type="stream">stream</return>

8607

<insert>icap_open(string calendar, string username, string password, string options);</insert>

8608

8609

8610

</function>

8611

8612

8613

Rename a calendar

8614

</description>

8615

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8616

8617

8618

<return type="string">string</return>

8619

<insert>icap_rename_calendar(int stream_id, string old_name, string new_name);</insert>

8620

<dialog title="Insert icap_rename_calendar">icap_rename_calendar(%0, %1, %2);</dialog>

8621

8622

</function>

8623

8624

8625

Reopen ICAP stream to new calendar

8626

</description>

8627

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8628

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

8629

<param name="options" required="0" vallist="0" default="" type="int">options</param>

8630

8631

<insert>icap_reopen(int stream_id, string calendar [,int options]);</insert>

8632

<dialog title="Insert icap_reopen">icap_reopen(%0, %1, %2);</dialog>

8633

8634

</function>

8635

8636

<description>Snooze an alarm</description>

8637

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8638

8639

<return type="string">string</return>

8640

<insert>icap_snooze(int stream_id, int uid);</insert>

8641

<dialog title="Insert icap_snooze">icap_snooze(%0, %1);</dialog>

8642

8643

</function>

8644

8645

<description>Store an event into an ICAP calendar</description>

8646

<param name="stream_id" required="1" vallist="0" default="" type="int">stream_id</param>

8647

<param name="event" required="1" vallist="0" default="" type="object">event</param>

8648

<return type="string">string</return>

8649

<insert>icap_store_event(int stream_id, object event);</insert>

8650

<dialog title="Insert icap_store_event">icap_store_event(%0, %1);</dialog>

8651

8652

</function>

8653

</group>

8654

8655

8656

<description>Get current setting for character encoding conversion</description>

8657

8658

<return type="array">array</return>

8659

<insert>iconv_get_encoding([string type]);</insert>

8660

<dialog title="Insert iconv_get_encoding">iconv_get_encoding(%0);</dialog>

8661

8662

</function>

8663

8664

<description>Set current setting for character encoding conversion</description>

8665

8666

<param name="charset" required="1" vallist="0" default="" type="string">charset</param>

8667

8668

<insert>iconv_set_encoding(string type, string charset);</insert>

8669

<dialog title="Insert iconv_set_encoding">iconv_set_encoding(%0, %1);</dialog>

8670

8671

</function>

8672

8673

<description>Convert string to requested character encoding</description>

8674

<param name="in_charset" required="1" vallist="0" default="" type="string">in_charset</param>

8675

<param name="out_charset" required="1" vallist="0" default="" type="string">out_charset</param>

8676

8677

<return type="string">string</return>

8678

<insert>iconv(string in_charset, string out_charset, string str);</insert>

8679

<dialog title="Insert iconv">iconv(%0, %1, %2);</dialog>

8680

8681

</function>

8682

8683

<description>Convert character encoding as output buffer handler</description>

8684

<param name="contents" required="1" vallist="0" default="" type="string">contents</param>

8685

<param name="status" required="1" vallist="0" default="" type="int">status</param>

8686

<return type="array">array</return>

8687

<insert>ob_iconv_handler(string contents, int status);</insert>

8688

<dialog title="Insert ob_iconv_handler">ob_iconv_handler(%0, %1);</dialog>

8689

8690

</function>

8691

</group>

8692

8693

8694

<description>Get number of rows affected by a query</description>

8695

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8696

8697

<insert>ifx_affected_rows(int result_id);</insert>

8698

<dialog title="Insert ifx_affected_rows">ifx_affected_rows(%0);</dialog>

8699

8700

</function>

8701

8702

<description>Set the default blob mode for all select queries</description>

8703

8704

8705

<insert>ifx_blobinfile_mode(int mode);</insert>

8706

<dialog title="Insert ifx_blobinfile_mode">ifx_blobinfile_mode(%0);</dialog>

8707

8708

</function>

8709

8710

<description>Set the default byte mode</description>

8711

8712

8713

<insert>ifx_byteasvarchar(int mode);</insert>

8714

<dialog title="Insert ifx_byteasvarchar">ifx_byteasvarchar(%0);</dialog>

8715

8716

</function>

8717

8718

<description>Close Informix connection</description>

8719

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

8720

8721

<insert>ifx_close([int link_identifier]);</insert>

8722

<dialog title="Insert ifx_close">ifx_close(%0);</dialog>

8723

8724

</function>

8725

8726

<description>Open Informix server connection</description>

8727

<param name="database

8728

" required="0" vallist="0" default="" type="string">database

8729

</param>

8730

<param name="userid

8731

" required="0" vallist="0" default="" type="string">userid

8732

</param>

8733

<param name="password

8734

" required="0" vallist="0" default="" type="string">password

8735

</param>

8736

8737

<insert>ifx_connect([string database

8738

] [,string userid

8739

] [,string password

8740

]);</insert>

8741

<dialog title="Insert ifx_connect">ifx_connect(%0, %1, %2);</dialog>

8742

8743

</function>

8744

8745

<description>Duplicates the given blob object</description>

8746

8747

8748

8749

8750

8751

</function>

8752

8753

<description>Creates an blob object</description>

8754

8755

8756

<param name="param" required="1" vallist="0" default="" type="string">param</param>

8757

8758

<insert>ifx_create_blob(int type, int mode, string param);</insert>

8759

<dialog title="Insert ifx_create_blob">ifx_create_blob(%0, %1, %2);</dialog>

8760

8761

</function>

8762

8763

<description>Creates an char object</description>

8764

<param name="param" required="1" vallist="0" default="" type="string">param</param>

8765

8766

<insert>ifx_create_char(string param);</insert>

8767

<dialog title="Insert ifx_create_char">ifx_create_char(%0);</dialog>

8768

8769

</function>

8770

8771

8772

Execute a previously prepared SQL-statement

8773

</description>

8774

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8775

8776

<insert>ifx_do(int result_id);</insert>

8777

8778

8779

</function>

8780

8781

<description>Returns error code of last Informix call</description>

8782

<return type="string">string</return>

8783

<insert>ifx_error();</insert>

8784

<dialog title="Insert ifx_error">ifx_error();</dialog>

8785

8786

</function>

8787

8788

<description>Returns error message of last Informix call</description>

8789

<param name="errorcode" required="0" vallist="0" default="" type="int">errorcode</param>

8790

<return type="string">string</return>

8791

<insert>ifx_errormsg([int errorcode]);</insert>

8792

<dialog title="Insert ifx_errormsg">ifx_errormsg(%0);</dialog>

8793

8794

</function>

8795

8796

<description>Get row as enumerated array</description>

8797

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8798

<param name="position" required="0" vallist="0" default="" type="mixed">position</param>

8799

<return type="array">array</return>

8800

<insert>ifx_fetch_row(int result_id [,mixed position]);</insert>

8801

<dialog title="Insert ifx_fetch_row">ifx_fetch_row(%0, %1);</dialog>

8802

8803

</function>

8804

8805

<description>List of SQL fieldproperties</description>

8806

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8807

<return type="array">array</return>

8808

<insert>ifx_fieldproperties(int result_id);</insert>

8809

<dialog title="Insert ifx_fieldproperties">ifx_fieldproperties(%0);</dialog>

8810

8811

</function>

8812

8813

<description>List of Informix SQL fields</description>

8814

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8815

<return type="array">array</return>

8816

<insert>ifx_fieldtypes(int result_id);</insert>

8817

<dialog title="Insert ifx_fieldtypes">ifx_fieldtypes(%0);</dialog>

8818

8819

</function>

8820

8821

<description>Deletes the blob object</description>

8822

8823

8824

8825

8826

8827

</function>

8828

8829

<description>Deletes the char object</description>

8830

8831

8832

8833

8834

8835

</function>

8836

8837

<description>Releases resources for the query</description>

8838

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8839

8840

<insert>ifx_free_result(int result_id);</insert>

8841

<dialog title="Insert ifx_free_result">ifx_free_result(%0);</dialog>

8842

8843

</function>

8844

8845

<description>Return the content of a blob object</description>

8846

8847

8848

8849

8850

8851

</function>

8852

8853

<description>Return the content of the char object</description>

8854

8855

8856

8857

8858

8859

</function>

8860

8861

8862

Get the contents of sqlca.sqlerrd[0..5] after a query

8863

</description>

8864

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8865

<return type="array">array</return>

8866

<insert>ifx_getsqlca(int result_id);</insert>

8867

<dialog title="Insert ifx_getsqlca">ifx_getsqlca(%0);</dialog>

8868

8869

</function>

8870

8871

8872

Formats all rows of a query into a HTML table

8873

</description>

8874

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8875

<param name="html_table_options" required="0" vallist="0" default="" type="string">html_table_options</param>

8876

8877

<insert>ifx_htmltbl_result(int result_id [,string html_table_options]);</insert>

8878

<dialog title="Insert ifx_htmltbl_result">ifx_htmltbl_result(%0, %1);</dialog>

8879

8880

</function>

8881

8882

8883

Sets the default return value on a fetch row

8884

</description>

8885

8886

8887

<insert>ifx_nullformat(int mode);</insert>

8888

<dialog title="Insert ifx_nullformat">ifx_nullformat(%0);</dialog>

8889

8890

</function>

8891

8892

<description>Returns the number of columns in the query</description>

8893

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8894

8895

<insert>ifx_num_fields(int result_id);</insert>

8896

<dialog title="Insert ifx_num_fields">ifx_num_fields(%0);</dialog>

8897

8898

</function>

8899

8900

<description>Count the rows already fetched from a query</description>

8901

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

8902

8903

<insert>ifx_num_rows(int result_id);</insert>

8904

8905

8906

</function>

8907

8908

<description>Open persistent Informix connection</description>

8909

<param name="database" required="0" vallist="0" default="" type="string">database</param>

8910

<param name="userid" required="0" vallist="0" default="" type="string">userid</param>

8911

<param name="password" required="0" vallist="0" default="" type="string">password</param>

8912

8913

<insert>ifx_pconnect([string database] [,string userid] [,string password]);</insert>

8914

<dialog title="Insert ifx_pconnect">ifx_pconnect(%0, %1, %2);</dialog>

8915

8916

</function>

8917

8918

<description>Prepare an SQL-statement for execution</description>

8919

<param name="query" required="1" vallist="0" default="" type="string">query</param>

8920

8921

<param name="cursor_def" required="0" vallist="0" default="" type="int">cursor_def</param>

8922

<param name="blobidarray" required="1" vallist="0" default="" type="mixed">blobidarray</param>

8923

8924

<insert>ifx_prepare(string query, int conn_id [,int cursor_def], mixed blobidarray);</insert>

8925

<dialog title="Insert ifx_prepare">ifx_prepare(%0, %1, %2, %3);</dialog>

8926

8927

</function>

8928

8929

<description>Send Informix query</description>

8930

<param name="query" required="1" vallist="0" default="" type="string">query</param>

8931

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

8932

<param name="cursor_type" required="0" vallist="0" default="" type="int">cursor_type</param>

8933

<param name="

8934

blobidarray

8935

" required="0" vallist="0" default="" type="mixed">

8936

blobidarray

8937

</param>

8938

8939

<insert>ifx_query(string query, int link_identifier [,int cursor_type] [,mixed

8940

blobidarray

8941

]);</insert>

8942

<dialog title="Insert ifx_query">ifx_query(%0, %1, %2, %3);</dialog>

8943

8944

</function>

8945

8946

<description>Set the default text mode</description>

8947

8948

8949

<insert>ifx_textasvarchar(int mode);</insert>

8950

<dialog title="Insert ifx_textasvarchar">ifx_textasvarchar(%0);</dialog>

8951

8952

</function>

8953

8954

<description>Updates the content of the blob object</description>

8955

8956

<param name="content" required="1" vallist="0" default="" type="string">content</param>

8957

8958

<insert>ifx_update_blob(int bid, string content);</insert>

8959

<dialog title="Insert ifx_update_blob">ifx_update_blob(%0, %1);</dialog>

8960

8961

</function>

8962

8963

<description>Updates the content of the char object</description>

8964

8965

<param name="content" required="1" vallist="0" default="" type="string">content</param>

8966

8967

<insert>ifx_update_char(int bid, string content);</insert>

8968

<dialog title="Insert ifx_update_char">ifx_update_char(%0, %1);</dialog>

8969

8970

</function>

8971

8972

<description>Deletes the slob object</description>

8973

8974

8975

<insert>ifxus_close_slob(int bid);</insert>

8976

<dialog title="Insert ifxus_close_slob">ifxus_close_slob(%0);</dialog>

8977

8978

</function>

8979

8980

<description>Creates an slob object and opens it</description>

8981

8982

8983

<insert>ifxus_create_slob(int mode);</insert>

8984

<dialog title="Insert ifxus_create_slob">ifxus_create_slob(%0);</dialog>

8985

8986

</function>

8987

8988

<description>Deletes the slob object</description>

8989

8990

8991

<insert>ifxus_free_slob(int bid);</insert>

8992

<dialog title="Insert ifxus_free_slob">ifxus_free_slob(%0);</dialog>

8993

8994

</function>

8995

8996

<description>Opens an slob object</description>

8997

8998

8999

9000

<insert>ifxus_open_slob(long bid, int mode);</insert>

9001

<dialog title="Insert ifxus_open_slob">ifxus_open_slob(%0, %1);</dialog>

9002

9003

</function>

9004

9005

<description>Reads nbytes of the slob object</description>

9006

9007

<param name="nbytes" required="1" vallist="0" default="" type="long">nbytes</param>

9008

9009

<insert>ifxus_read_slob(long bid, long nbytes);</insert>

9010

<dialog title="Insert ifxus_read_slob">ifxus_read_slob(%0, %1);</dialog>

9011

9012

</function>

9013

9014

<description>Sets the current file or seek position</description>

9015

9016

9017

<param name="offset" required="1" vallist="0" default="" type="long">offset</param>

9018

9019

<insert>ifxus_seek_slob(long bid, int mode, long offset);</insert>

9020

<dialog title="Insert ifxus_seek_slob">ifxus_seek_slob(%0, %1, %2);</dialog>

9021

9022

</function>

9023

9024

<description>Returns the current file or seek position</description>

9025

9026

9027

<insert>ifxus_tell_slob(long bid);</insert>

9028

<dialog title="Insert ifxus_tell_slob">ifxus_tell_slob(%0);</dialog>

9029

9030

</function>

9031

9032

<description>Writes a string into the slob object</description>

9033

9034

<param name="content" required="1" vallist="0" default="" type="string">content</param>

9035

9036

<insert>ifxus_write_slob(long bid, string content);</insert>

9037

<dialog title="Insert ifxus_write_slob">ifxus_write_slob(%0, %1);</dialog>

9038

9039

</function>

9040

</group>

9041

9042

9043

<description>Creates a new virtual web server</description>

9044

9045

<param name="comment" required="1" vallist="0" default="" type="string">comment</param>

9046

<param name="server_ip" required="1" vallist="0" default="" type="string">server_ip</param>

9047

9048

9049

<param name="rights" required="1" vallist="0" default="" type="int">rights</param>

9050

<param name="start_server" required="1" vallist="0" default="" type="int">start_server</param>

9051

9052

<insert>iis_add_server(string path, string comment, string server_ip, int port, string host_name, int rights, int start_server);</insert>

9053

<dialog title="Insert iis_add_server">iis_add_server(%0, %1, %2, %3, %4, %5, %6);</dialog>

9054

9055

</function>

9056

9057

<description>Gets Directory Security</description>

9058

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9059

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9060

9061

<insert>iis_get_dir_security(int server_instance, string virtual_path);</insert>

9062

<dialog title="Insert iis_get_dir_security">iis_get_dir_security(%0, %1);</dialog>

9063

9064

</function>

9065

9066

<description>Gets script mapping on a virtual directory for a specific extention</description>

9067

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9068

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9069

<param name="script_extension" required="1" vallist="0" default="" type="string">script_extension</param>

9070

9071

<insert>iis_get_script_map(int server_instance, string virtual_path, string script_extension);</insert>

9072

<dialog title="Insert iis_get_script_map">iis_get_script_map(%0, %1, %2);</dialog>

9073

9074

</function>

9075

9076

<description>Return the instance number associated with the Comment</description>

9077

<param name="comment" required="1" vallist="0" default="" type="string">comment</param>

9078

9079

<insert>iis_get_server_by_comment(string comment);</insert>

9080

<dialog title="Insert iis_get_server_by_comment">iis_get_server_by_comment(%0);</dialog>

9081

9082

</function>

9083

9084

<description>Return the instance number associated with the Path</description>

9085

9086

9087

<insert>iis_get_server_by_path(string path);</insert>

9088

<dialog title="Insert iis_get_server_by_path">iis_get_server_by_path(%0);</dialog>

9089

9090

</function>

9091

9092

<description>Gets server rights</description>

9093

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9094

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9095

9096

<insert>iis_get_server_rights(int server_instance, string virtual_path);</insert>

9097

<dialog title="Insert iis_get_server_rights">iis_get_server_rights(%0, %1);</dialog>

9098

9099

</function>

9100

9101

<description>Starts the service defined by ServiceId</description>

9102

<param name="service_id" required="1" vallist="0" default="" type="string">service_id</param>

9103

9104

<insert>iis_get_service_state(string service_id);</insert>

9105

<dialog title="Insert iis_get_service_state">iis_get_service_state(%0);</dialog>

9106

9107

</function>

9108

9109

<description>Removes the virtual web server indicated by ServerInstance</description>

9110

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9111

9112

<insert>iis_remove_server(int server_instance);</insert>

9113

<dialog title="Insert iis_remove_server">iis_remove_server(%0);</dialog>

9114

9115

</function>

9116

9117

<description>Creates application scope for a virtual directory</description>

9118

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9119

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9120

<param name="application_scope" required="1" vallist="0" default="" type="string">application_scope</param>

9121

9122

<insert>iis_set_app_settings(int server_instance, string virtual_path, string application_scope);</insert>

9123

<dialog title="Insert iis_set_app_settings">iis_set_app_settings(%0, %1, %2);</dialog>

9124

9125

</function>

9126

9127

<description>Sets Directory Security</description>

9128

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9129

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9130

<param name="directory_flags" required="1" vallist="0" default="" type="int">directory_flags</param>

9131

9132

<insert>iis_set_dir_security(int server_instance, string virtual_path, int directory_flags);</insert>

9133

<dialog title="Insert iis_set_dir_security">iis_set_dir_security(%0, %1, %2);</dialog>

9134

9135

</function>

9136

9137

<description>Sets script mapping on a virtual directory</description>

9138

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9139

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9140

<param name="script_extension" required="1" vallist="0" default="" type="string">script_extension</param>

9141

<param name="engine_path" required="1" vallist="0" default="" type="string">engine_path</param>

9142

<param name="allow_scripting" required="1" vallist="0" default="" type="int">allow_scripting</param>

9143

9144

<insert>iis_set_script_map(int server_instance, string virtual_path, string script_extension, string engine_path, int allow_scripting);</insert>

9145

<dialog title="Insert iis_set_script_map">iis_set_script_map(%0, %1, %2, %3, %4);</dialog>

9146

9147

</function>

9148

9149

<description>Sets server rights</description>

9150

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9151

<param name="virtual_path" required="1" vallist="0" default="" type="string">virtual_path</param>

9152

<param name="directory_flags" required="1" vallist="0" default="" type="int">directory_flags</param>

9153

9154

<insert>iis_set_server_rights(int server_instance, string virtual_path, int directory_flags);</insert>

9155

<dialog title="Insert iis_set_server_rights">iis_set_server_rights(%0, %1, %2);</dialog>

9156

9157

</function>

9158

9159

<description>Starts the virtual web server</description>

9160

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9161

9162

<insert>iis_start_server(int server_instance);</insert>

9163

<dialog title="Insert iis_start_server">iis_start_server(%0);</dialog>

9164

9165

</function>

9166

9167

<description>Starts the service defined by ServiceId</description>

9168

<param name="service_id" required="1" vallist="0" default="" type="string">service_id</param>

9169

9170

<insert>iis_start_service(string service_id);</insert>

9171

<dialog title="Insert iis_start_service">iis_start_service(%0);</dialog>

9172

9173

</function>

9174

9175

<description>Stops the virtual web server</description>

9176

<param name="server_instance" required="1" vallist="0" default="" type="int">server_instance</param>

9177

9178

<insert>iis_stop_server(int server_instance);</insert>

9179

<dialog title="Insert iis_stop_server">iis_stop_server(%0);</dialog>

9180

9181

</function>

9182

9183

<description>Stops the service defined by ServiceId</description>

9184

<param name="service_id" required="1" vallist="0" default="" type="string">service_id</param>

9185

9186

<insert>iis_stop_service(string service_id);</insert>

9187

<dialog title="Insert iis_stop_service">iis_stop_service(%0);</dialog>

9188

9189

</function>

9190

</group>

9191

9192

9193

<description>Determine the type of an image</description>

9194

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9195

9196

<insert>exif_imagetype(string filename);</insert>

9197

<dialog title="Insert exif_imagetype">exif_imagetype(%0);</dialog>

9198

9199

</function>

9200

9201

9202

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9203

<param name="sections" required="0" vallist="0" default="" type="string">sections</param>

9204

<param name="arrays" required="0" vallist="0" default="" type="bool">arrays</param>

9205

<param name="thumbnail" required="0" vallist="0" default="" type="bool">thumbnail</param>

9206

<return type="array">array</return>

9207

<insert>exif_read_data(string filename [,string sections] [,bool arrays] [,bool thumbnail]);</insert>

9208

9209

9210

</function>

9211

9212

<description>Retrieve the embedded thumbnail of a TIFF or JPEG image</description>

9213

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9214

<param name="&width" required="0" vallist="0" default="" type="int">&width</param>

9215

<param name="&height" required="0" vallist="0" default="" type="int">&height</param>

9216

<param name="&imagetype" required="0" vallist="0" default="" type="int">&imagetype</param>

9217

<return type="string">string</return>

9218

<insert>exif_thumbnail(string filename [,int &width] [,int &height] [,int &imagetype]);</insert>

9219

<dialog title="Insert exif_thumbnail">exif_thumbnail(%0, %1, %2, %3);</dialog>

9220

9221

</function>

9222

9223

<description>Retrieve information about the currently installed GD library</description>

9224

<return type="array">array</return>

9225

9226

9227

9228

</function>

9229

9230

<description>Get the size of an image</description>

9231

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9232

<param name="imageinfo" required="0" vallist="0" default="" type="array">imageinfo</param>

9233

<return type="array">array</return>

9234

<insert>getimagesize(string filename [,array imageinfo]);</insert>

9235

<dialog title="Insert getimagesize">getimagesize(%0, %1);</dialog>

9236

9237

</function>

9238

9239

<description>Get Mime-Type for image-type returned by getimagesize,

9240

exif_read_data, exif_thumbnail, exif_imagetype</description>

9241

<param name="imagetype" required="1" vallist="0" default="" type="int">imagetype</param>

9242

<return type="string ">string </return>

9243

<insert>image_type_to_mime_type(int imagetype);</insert>

9244

<dialog title="Insert image_type_to_mime_type">image_type_to_mime_type(%0);</dialog>

9245

9246

</function>

9247

9248

<description>Output image to browser or file</description>

9249

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9250

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9251

<param name="threshold" required="0" vallist="0" default="" type="int">threshold</param>

9252

9253

<insert>image2wbmp(resource image [,string filename] [,int threshold]);</insert>

9254

<dialog title="Insert image2wbmp">image2wbmp(%0, %1, %2);</dialog>

9255

9256

</function>

9257

9258

<description>Set the blending mode for an image</description>

9259

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9260

<param name="blendmode" required="1" vallist="0" default="" type="bool">blendmode</param>

9261

9262

<insert>imagealphablending(resource image, bool blendmode);</insert>

9263

<dialog title="Insert imagealphablending">imagealphablending(%0, %1);</dialog>

9264

9265

</function>

9266

9267

<description>Draw a partial ellipse</description>

9268

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9269

9270

9271

9272

9273

9274

9275

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9276

9277

<insert>imagearc(resource image, int cx, int cy, int w, int h, int s, int e, int color);</insert>

9278

<dialog title="Insert imagearc">imagearc(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

9279

9280

</function>

9281

9282

<description>Draw a character horizontally</description>

9283

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9284

9285

9286

9287

9288

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9289

9290

<insert>imagechar(resource image, int font, int x, int y, string c, int color);</insert>

9291

<dialog title="Insert imagechar">imagechar(%0, %1, %2, %3, %4, %5);</dialog>

9292

9293

</function>

9294

9295

<description>Draw a character vertically</description>

9296

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9297

9298

9299

9300

9301

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9302

9303

<insert>imagecharup(resource image, int font, int x, int y, string c, int color);</insert>

9304

<dialog title="Insert imagecharup">imagecharup(%0, %1, %2, %3, %4, %5);</dialog>

9305

9306

</function>

9307

9308

<description>Allocate a color for an image</description>

9309

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9310

9311

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9312

9313

9314

<insert>imagecolorallocate(resource image, int red, int green, int blue);</insert>

9315

<dialog title="Insert imagecolorallocate">imagecolorallocate(%0, %1, %2, %3);</dialog>

9316

9317

</function>

9318

9319

<description>Allocate a color for an image</description>

9320

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9321

9322

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9323

9324

<param name="alpha" required="1" vallist="0" default="" type="int">alpha</param>

9325

9326

<insert>imagecolorallocatealpha(resource image, int red, int green, int blue, int alpha);</insert>

9327

<dialog title="Insert imagecolorallocatealpha">imagecolorallocatealpha(%0, %1, %2, %3, %4);</dialog>

9328

9329

</function>

9330

9331

<description>Get the index of the color of a pixel</description>

9332

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9333

9334

9335

9336

<insert>imagecolorat(resource image, int x, int y);</insert>

9337

<dialog title="Insert imagecolorat">imagecolorat(%0, %1, %2);</dialog>

9338

9339

</function>

9340

9341

<description>Get the index of the closest color to the specified color</description>

9342

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9343

9344

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9345

9346

9347

<insert>imagecolorclosest(resource image, int red, int green, int blue);</insert>

9348

<dialog title="Insert imagecolorclosest">imagecolorclosest(%0, %1, %2, %3);</dialog>

9349

9350

</function>

9351

9352

<description>Get the index of the closest color to the specified color + alpha</description>

9353

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9354

9355

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9356

9357

<param name="alpha" required="1" vallist="0" default="" type="int">alpha</param>

9358

9359

<insert>imagecolorclosestalpha(resource image, int red, int green, int blue, int alpha);</insert>

9360

<dialog title="Insert imagecolorclosestalpha">imagecolorclosestalpha(%0, %1, %2, %3, %4);</dialog>

9361

9362

</function>

9363

9364

9365

Get the index of the color which has the hue, white and blackness nearest to the given color

9366

</description>

9367

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9368

9369

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9370

9371

9372

<insert>imagecolorclosesthwb(resource image, int red, int green, int blue);</insert>

9373

<dialog title="Insert imagecolorclosesthwb">imagecolorclosesthwb(%0, %1, %2, %3);</dialog>

9374

9375

</function>

9376

9377

<description>De-allocate a color for an image</description>

9378

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9379

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9380

9381

<insert>imagecolordeallocate(resource image, int color);</insert>

9382

<dialog title="Insert imagecolordeallocate">imagecolordeallocate(%0, %1);</dialog>

9383

9384

</function>

9385

9386

<description>Get the index of the specified color</description>

9387

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9388

9389

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9390

9391

9392

<insert>imagecolorexact(resource image, int red, int green, int blue);</insert>

9393

<dialog title="Insert imagecolorexact">imagecolorexact(%0, %1, %2, %3);</dialog>

9394

9395

</function>

9396

9397

<description>Get the index of the specified color + alpha</description>

9398

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9399

9400

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9401

9402

<param name="alpha" required="1" vallist="0" default="" type="int">alpha</param>

9403

9404

<insert>imagecolorexactalpha(resource image, int red, int green, int blue, int alpha);</insert>

9405

<dialog title="Insert imagecolorexactalpha">imagecolorexactalpha(%0, %1, %2, %3, %4);</dialog>

9406

9407

</function>

9408

9409

9410

Get the index of the specified color or its closest possible

9411

alternative

9412

</description>

9413

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9414

9415

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9416

9417

9418

<insert>imagecolorresolve(resource image, int red, int green, int blue);</insert>

9419

<dialog title="Insert imagecolorresolve">imagecolorresolve(%0, %1, %2, %3);</dialog>

9420

9421

</function>

9422

9423

9424

Get the index of the specified color + alpha or its closest possible

9425

alternative

9426

</description>

9427

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9428

9429

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9430

9431

<param name="alpha" required="1" vallist="0" default="" type="int">alpha</param>

9432

9433

<insert>imagecolorresolvealpha(resource image, int red, int green, int blue, int alpha);</insert>

9434

<dialog title="Insert imagecolorresolvealpha">imagecolorresolvealpha(%0, %1, %2, %3, %4);</dialog>

9435

9436

</function>

9437

9438

<description>Set the color for the specified palette index</description>

9439

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9440

<param name="index" required="1" vallist="0" default="" type="int">index</param>

9441

9442

<param name="green" required="1" vallist="0" default="" type="int">green</param>

9443

9444

9445

<insert>imagecolorset(resource image, int index, int red, int green, int blue);</insert>

9446

<dialog title="Insert imagecolorset">imagecolorset(%0, %1, %2, %3, %4);</dialog>

9447

9448

</function>

9449

9450

<description>Get the colors for an index</description>

9451

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9452

<param name="index" required="1" vallist="0" default="" type="int">index</param>

9453

<return type="array">array</return>

9454

<insert>imagecolorsforindex(resource image, int index);</insert>

9455

<dialog title="Insert imagecolorsforindex">imagecolorsforindex(%0, %1);</dialog>

9456

9457

</function>

9458

9459

<description>Find out the number of colors in an image's palette</description>

9460

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9461

9462

<insert>imagecolorstotal(resource image);</insert>

9463

<dialog title="Insert imagecolorstotal">imagecolorstotal(%0);</dialog>

9464

9465

</function>

9466

9467

<description>Define a color as transparent</description>

9468

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9469

<param name="color" required="0" vallist="0" default="" type="int">color</param>

9470

9471

<insert>imagecolortransparent(resource image [,int color]);</insert>

9472

<dialog title="Insert imagecolortransparent">imagecolortransparent(%0, %1);</dialog>

9473

9474

</function>

9475

9476

<description>Copy part of an image</description>

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

<insert>imagecopy(resource dst_im, resource src_im, int dst_x, int dst_y, int src_x, int src_y, int src_w, int src_h);</insert>

9487

<dialog title="Insert imagecopy">imagecopy(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

9488

9489

</function>

9490

9491

<description>Copy and merge part of an image</description>

9492

9493

9494

9495

9496

9497

9498

9499

9500

9501

9502

<insert>imagecopymerge(resource dst_im, resource src_im, int dst_x, int dst_y, int src_x, int src_y, int src_w, int src_h, int pct);</insert>

9503

<dialog title="Insert imagecopymerge">imagecopymerge(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

9504

9505

</function>

9506

9507

<description>Copy and merge part of an image with gray scale</description>

9508

9509

9510

9511

9512

9513

9514

9515

9516

9517

9518

<insert>imagecopymergegray(resource dst_im, resource src_im, int dst_x, int dst_y, int src_x, int src_y, int src_w, int src_h, int pct);</insert>

9519

<dialog title="Insert imagecopymergegray">imagecopymergegray(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

9520

9521

</function>

9522

9523

<description>Copy and resize part of an image with resampling</description>

9524

9525

9526

9527

9528

9529

9530

9531

9532

9533

9534

9535

<insert>imagecopyresampled(resource dst_im, resource src_im, int dstX, int dstY, int srcX, int srcY, int dstW, int dstH, int srcW, int srcH);</insert>

9536

<dialog title="Insert imagecopyresampled">imagecopyresampled(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9);</dialog>

9537

9538

</function>

9539

9540

<description>Copy and resize part of an image</description>

9541

9542

9543

9544

9545

9546

9547

9548

9549

9550

9551

9552

<insert>imagecopyresized(resource dst_im, resource src_im, int dstX, int dstY, int srcX, int srcY, int dstW, int dstH, int srcW, int srcH);</insert>

9553

<dialog title="Insert imagecopyresized">imagecopyresized(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9);</dialog>

9554

9555

</function>

9556

9557

<description>Create a new palette based image</description>

9558

9559

9560

<return type="resource">resource</return>

9561

<insert>imagecreate(int x_size, int y_size);</insert>

9562

<dialog title="Insert imagecreate">imagecreate(%0, %1);</dialog>

9563

9564

</function>

9565

9566

<description>Create a new image from GD file or URL</description>

9567

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9568

<return type="resource">resource</return>

9569

<insert>imagecreatefromgd(string filename);</insert>

9570

<dialog title="Insert imagecreatefromgd">imagecreatefromgd(%0);</dialog>

9571

9572

</function>

9573

9574

<description>Create a new image from GD2 file or URL</description>

9575

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9576

<return type="resource">resource</return>

9577

<insert>imagecreatefromgd2(string filename);</insert>

9578

<dialog title="Insert imagecreatefromgd2">imagecreatefromgd2(%0);</dialog>

9579

9580

</function>

9581

9582

<description>Create a new image from a given part of GD2 file or URL</description>

9583

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9584

9585

9586

<param name="width" required="1" vallist="0" default="" type="int">width</param>

9587

<param name="height" required="1" vallist="0" default="" type="int">height</param>

9588

<return type="resource">resource</return>

9589

<insert>imagecreatefromgd2part(string filename, int srcX, int srcY, int width, int height);</insert>

9590

<dialog title="Insert imagecreatefromgd2part">imagecreatefromgd2part(%0, %1, %2, %3, %4);</dialog>

9591

9592

</function>

9593

9594

<description>Create a new image from file or URL</description>

9595

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9596

<return type="resource">resource</return>

9597

<insert>imagecreatefromgif(string filename);</insert>

9598

<dialog title="Insert imagecreatefromgif">imagecreatefromgif(%0);</dialog>

9599

9600

</function>

9601

9602

<description>Create a new image from file or URL</description>

9603

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9604

<return type="resource">resource</return>

9605

<insert>imagecreatefromjpeg(string filename);</insert>

9606

<dialog title="Insert imagecreatefromjpeg">imagecreatefromjpeg(%0);</dialog>

9607

9608

</function>

9609

9610

<description>Create a new image from file or URL</description>

9611

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9612

<return type="resource">resource</return>

9613

<insert>imagecreatefrompng(string filename);</insert>

9614

<dialog title="Insert imagecreatefrompng">imagecreatefrompng(%0);</dialog>

9615

9616

</function>

9617

9618

<description>Create a new image from the image stream in the string</description>

9619

<param name="image" required="1" vallist="0" default="" type="string">image</param>

9620

<return type="resource">resource</return>

9621

<insert>imagecreatefromstring(string image);</insert>

9622

<dialog title="Insert imagecreatefromstring">imagecreatefromstring(%0);</dialog>

9623

9624

</function>

9625

9626

<description>Create a new image from file or URL</description>

9627

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9628

<return type="resource">resource</return>

9629

<insert>imagecreatefromwbmp(string filename);</insert>

9630

<dialog title="Insert imagecreatefromwbmp">imagecreatefromwbmp(%0);</dialog>

9631

9632

</function>

9633

9634

<description>Create a new image from file or URL</description>

9635

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9636

<return type="resource">resource</return>

9637

<insert>imagecreatefromxbm(string filename);</insert>

9638

<dialog title="Insert imagecreatefromxbm">imagecreatefromxbm(%0);</dialog>

9639

9640

</function>

9641

9642

<description>Create a new image from file or URL</description>

9643

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9644

<return type="resource">resource</return>

9645

<insert>imagecreatefromxpm(string filename);</insert>

9646

<dialog title="Insert imagecreatefromxpm">imagecreatefromxpm(%0);</dialog>

9647

9648

</function>

9649

9650

<description>Create a new true color image</description>

9651

9652

9653

<return type="resource">resource</return>

9654

<insert>imagecreatetruecolor(int x_size, int y_size);</insert>

9655

<dialog title="Insert imagecreatetruecolor">imagecreatetruecolor(%0, %1);</dialog>

9656

9657

</function>

9658

9659

<description>Draw a dashed line</description>

9660

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9661

9662

9663

9664

9665

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9666

9667

<insert>imagedashedline(resource image, int x1, int y1, int x2, int y2, int color);</insert>

9668

<dialog title="Insert imagedashedline">imagedashedline(%0, %1, %2, %3, %4, %5);</dialog>

9669

9670

</function>

9671

9672

<description>Destroy an image</description>

9673

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9674

9675

<insert>imagedestroy(resource image);</insert>

9676

<dialog title="Insert imagedestroy">imagedestroy(%0);</dialog>

9677

9678

</function>

9679

9680

<description>Draw an ellipse</description>

9681

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9682

9683

9684

9685

9686

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9687

9688

<insert>imageellipse(resource image, int cx, int cy, int w, int h, int color);</insert>

9689

<dialog title="Insert imageellipse">imageellipse(%0, %1, %2, %3, %4, %5);</dialog>

9690

9691

</function>

9692

9693

<description>Flood fill</description>

9694

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9695

9696

9697

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9698

9699

<insert>imagefill(resource image, int x, int y, int color);</insert>

9700

<dialog title="Insert imagefill">imagefill(%0, %1, %2, %3);</dialog>

9701

9702

</function>

9703

9704

<description>Draw a partial ellipse and fill it</description>

9705

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9706

9707

9708

9709

9710

9711

9712

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9713

<param name="style" required="1" vallist="0" default="" type="int">style</param>

9714

9715

<insert>imagefilledarc(resource image, int cx, int cy, int w, int h, int s, int e, int color, int style);</insert>

9716

<dialog title="Insert imagefilledarc">imagefilledarc(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

9717

9718

</function>

9719

9720

<description>Draw a filled ellipse</description>

9721

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9722

9723

9724

9725

9726

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9727

9728

<insert>imagefilledellipse(resource image, int cx, int cy, int w, int h, int color);</insert>

9729

<dialog title="Insert imagefilledellipse">imagefilledellipse(%0, %1, %2, %3, %4, %5);</dialog>

9730

9731

</function>

9732

9733

<description>Draw a filled polygon</description>

9734

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9735

<param name="points" required="1" vallist="0" default="" type="array">points</param>

9736

<param name="num_points" required="1" vallist="0" default="" type="int">num_points</param>

9737

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9738

9739

<insert>imagefilledpolygon(resource image, array points, int num_points, int color);</insert>

9740

<dialog title="Insert imagefilledpolygon">imagefilledpolygon(%0, %1, %2, %3);</dialog>

9741

9742

</function>

9743

9744

<description>Draw a filled rectangle</description>

9745

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9746

9747

9748

9749

9750

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9751

9752

<insert>imagefilledrectangle(resource image, int x1, int y1, int x2, int y2, int color);</insert>

9753

<dialog title="Insert imagefilledrectangle">imagefilledrectangle(%0, %1, %2, %3, %4, %5);</dialog>

9754

9755

</function>

9756

9757

<description>Flood fill to specific color</description>

9758

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9759

9760

9761

<param name="border" required="1" vallist="0" default="" type="int">border</param>

9762

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9763

9764

<insert>imagefilltoborder(resource image, int x, int y, int border, int color);</insert>

9765

<dialog title="Insert imagefilltoborder">imagefilltoborder(%0, %1, %2, %3, %4);</dialog>

9766

9767

</function>

9768

9769

<description>Get font height</description>

9770

9771

9772

<insert>imagefontheight(int font);</insert>

9773

<dialog title="Insert imagefontheight">imagefontheight(%0);</dialog>

9774

9775

</function>

9776

9777

<description>Get font width</description>

9778

9779

9780

<insert>imagefontwidth(int font);</insert>

9781

<dialog title="Insert imagefontwidth">imagefontwidth(%0);</dialog>

9782

9783

</function>

9784

9785

<description>Give the bounding box of a text using fonts via freetype2</description>

9786

9787

<param name="angle" required="1" vallist="0" default="" type="int">angle</param>

9788

9789

9790

<param name="extrainfo" required="0" vallist="0" default="" type="array">extrainfo</param>

9791

<return type="array">array</return>

9792

<insert>imageftbbox(int size, int angle, string font_file, string text [,array extrainfo]);</insert>

9793

<dialog title="Insert imageftbbox">imageftbbox(%0, %1, %2, %3, %4);</dialog>

9794

9795

</function>

9796

9797

<description>Write text to the image using fonts using FreeType 2</description>

9798

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9799

9800

<param name="angle" required="1" vallist="0" default="" type="int">angle</param>

9801

9802

9803

9804

9805

9806

<param name="extrainfo" required="0" vallist="0" default="" type="array">extrainfo</param>

9807

<return type="array">array</return>

9808

<insert>imagefttext(resource image, int size, int angle, int x, int y, int col, string font_file, string text [,array extrainfo]);</insert>

9809

<dialog title="Insert imagefttext">imagefttext(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

9810

9811

</function>

9812

9813

<description>Apply a gamma correction to a GD image</description>

9814

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9815

<param name="inputgamma" required="1" vallist="0" default="" type="float">inputgamma</param>

9816

<param name="outputgamma" required="1" vallist="0" default="" type="float">outputgamma</param>

9817

9818

<insert>imagegammacorrect(resource image, float inputgamma, float outputgamma);</insert>

9819

<dialog title="Insert imagegammacorrect">imagegammacorrect(%0, %1, %2);</dialog>

9820

9821

</function>

9822

9823

<description>Output GD image to browser or file</description>

9824

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9825

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9826

9827

<insert>imagegd(resource image [,string filename]);</insert>

9828

<dialog title="Insert imagegd">imagegd(%0, %1);</dialog>

9829

9830

</function>

9831

9832

<description>Output GD2 image</description>

9833

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9834

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9835

<param name="chunk_size" required="0" vallist="0" default="" type="int">chunk_size</param>

9836

9837

9838

<insert>imagegd2(resource image [,string filename] [,int chunk_size] [,int type]);</insert>

9839

<dialog title="Insert imagegd2">imagegd2(%0, %1, %2, %3);</dialog>

9840

9841

</function>

9842

9843

<description>Output image to browser or file</description>

9844

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9845

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9846

9847

<insert>imagegif(resource image [,string filename]);</insert>

9848

<dialog title="Insert imagegif">imagegif(%0, %1);</dialog>

9849

9850

</function>

9851

9852

<description>Enable or disable interlace</description>

9853

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9854

<param name="interlace" required="0" vallist="0" default="" type="int">interlace</param>

9855

9856

<insert>imageinterlace(resource image [,int interlace]);</insert>

9857

<dialog title="Insert imageinterlace">imageinterlace(%0, %1);</dialog>

9858

9859

</function>

9860

9861

<description>Finds whether an image is a truecolor image.</description>

9862

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9863

9864

<insert>imageistruecolorcreate(resource image);</insert>

9865

<dialog title="Insert imageistruecolorcreate">imageistruecolorcreate(%0);</dialog>

9866

9867

</function>

9868

9869

<description>Output image to browser or file</description>

9870

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9871

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9872

<param name="quality" required="0" vallist="0" default="" type="int">quality</param>

9873

9874

<insert>imagejpeg(resource image [,string filename] [,int quality]);</insert>

9875

<dialog title="Insert imagejpeg">imagejpeg(%0, %1, %2);</dialog>

9876

9877

</function>

9878

9879

9880

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9881

9882

9883

9884

9885

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9886

9887

<insert>imageline(resource image, int x1, int y1, int x2, int y2, int color);</insert>

9888

<dialog title="Insert imageline">imageline(%0, %1, %2, %3, %4, %5);</dialog>

9889

9890

</function>

9891

9892

9893

9894

9895

<insert>imageloadfont(string file);</insert>

9896

<dialog title="Insert imageloadfont">imageloadfont(%0);</dialog>

9897

9898

</function>

9899

9900

<description>Copy the palette from one image to another</description>

9901

<param name="destination" required="1" vallist="0" default="" type="resource">destination</param>

9902

<param name="source" required="1" vallist="0" default="" type="resource">source</param>

9903

9904

<insert>imagepalettecopy(resource destination, resource source);</insert>

9905

<dialog title="Insert imagepalettecopy">imagepalettecopy(%0, %1);</dialog>

9906

9907

</function>

9908

9909

<description>Output a PNG image to either the browser or a file</description>

9910

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9911

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

9912

9913

<insert>imagepng(resource image [,string filename]);</insert>

9914

<dialog title="Insert imagepng">imagepng(%0, %1);</dialog>

9915

9916

</function>

9917

9918

<description>Draw a polygon</description>

9919

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

9920

<param name="points" required="1" vallist="0" default="" type="array">points</param>

9921

<param name="num_points" required="1" vallist="0" default="" type="int">num_points</param>

9922

<param name="color" required="1" vallist="0" default="" type="int">color</param>

9923

9924

<insert>imagepolygon(resource image, array points, int num_points, int color);</insert>

9925

<dialog title="Insert imagepolygon">imagepolygon(%0, %1, %2, %3);</dialog>

9926

9927

</function>

9928

9929

9930

Give the bounding box of a text rectangle using PostScript Type1

9931

fonts

9932

</description>

9933

9934

9935

9936

<param name="space" required="0" vallist="0" default="" type="int">space</param>

9937

<param name="tightness" required="0" vallist="0" default="" type="int">tightness</param>

9938

<param name="angle" required="0" vallist="0" default="" type="float">angle</param>

9939

<return type="array">array</return>

9940

<insert>imagepsbbox(string text, int font, int size [,int space] [,int tightness] [,float angle]);</insert>

9941

<dialog title="Insert imagepsbbox">imagepsbbox(%0, %1, %2, %3, %4, %5);</dialog>

9942

9943

</function>

9944

9945

9946

Make a copy of an already loaded font for further modification

9947

</description>

9948

<param name="fontindex" required="1" vallist="0" default="" type="int">fontindex</param>

9949

9950

<insert>imagepscopyfont(int fontindex);</insert>

9951

<dialog title="Insert imagepscopyfont">imagepscopyfont(%0);</dialog>

9952

9953

</function>

9954

9955

<description>Change the character encoding vector of a font</description>

9956

<param name="font_index" required="1" vallist="0" default="" type="int">font_index</param>

9957

<param name="encodingfile" required="1" vallist="0" default="" type="string">encodingfile</param>

9958

9959

<insert>imagepsencodefont(int font_index, string encodingfile);</insert>

9960

<dialog title="Insert imagepsencodefont">imagepsencodefont(%0, %1);</dialog>

9961

9962

</function>

9963

9964

<description>Extend or condense a font</description>

9965

<param name="font_index" required="1" vallist="0" default="" type="int">font_index</param>

9966

<param name="extend" required="1" vallist="0" default="" type="float">extend</param>

9967

9968

<insert>imagepsextendfont(int font_index, float extend);</insert>

9969

<dialog title="Insert imagepsextendfont">imagepsextendfont(%0, %1);</dialog>

9970

9971

</function>

9972

9973

<description>Free memory used by a PostScript Type 1 font</description>

9974

<param name="fontindex" required="1" vallist="0" default="" type="int">fontindex</param>

9975

9976

<insert>imagepsfreefont(int fontindex);</insert>

9977

<dialog title="Insert imagepsfreefont">imagepsfreefont(%0);</dialog>

9978

9979

</function>

9980

9981

<description>Load a PostScript Type 1 font from file</description>

9982

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

9983

9984

<insert>imagepsloadfont(string filename);</insert>

9985

<dialog title="Insert imagepsloadfont">imagepsloadfont(%0);</dialog>

9986

9987

</function>

9988

9989

<description>Slant a font</description>

9990

<param name="font_index" required="1" vallist="0" default="" type="int">font_index</param>

9991

<param name="slant" required="1" vallist="0" default="" type="float">slant</param>

9992

9993

<insert>imagepsslantfont(int font_index, float slant);</insert>

9994

<dialog title="Insert imagepsslantfont">imagepsslantfont(%0, %1);</dialog>

9995

9996

</function>

9997

9998

<description>To draw a text string over an image using PostScript Type1 fonts</description>

9999

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10000

10001

10002

10003

<param name="foreground" required="1" vallist="0" default="" type="int">foreground</param>

10004

<param name="background" required="1" vallist="0" default="" type="int">background</param>

10005

10006

10007

<param name="

10008

space

10009

" required="0" vallist="0" default="" type="int">

10010

space

10011

</param>

10012

<param name="

10013

tightness

10014

" required="0" vallist="0" default="" type="int">

10015

tightness

10016

</param>

10017

<param name="

10018

angle

10019

" required="0" vallist="0" default="" type="float">

10020

angle

10021

</param>

10022

<param name="

10023

antialias_steps

10024

" required="0" vallist="0" default="" type="int">

10025

antialias_steps

10026

</param>

10027

<return type="array">array</return>

10028

<insert>imagepstext(resource image, string text, int font, int size, int foreground, int background, int x, int y [,int

10029

space

10030

] [,int

10031

tightness

10032

] [,float

10033

angle

10034

] [,int

10035

antialias_steps

10036

]);</insert>

10037

<dialog title="Insert imagepstext">imagepstext(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10, %11);</dialog>

10038

10039

</function>

10040

10041

<description>Draw a rectangle</description>

10042

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10043

10044

10045

10046

10047

10048

10049

<insert>imagerectangle(resource image, int x1, int y1, int x2, int y2, int col);</insert>

10050

<dialog title="Insert imagerectangle">imagerectangle(%0, %1, %2, %3, %4, %5);</dialog>

10051

10052

</function>

10053

10054

<description>Rotate an image with a given angle</description>

10055

10056

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

10057

<param name="bgd_color" required="1" vallist="0" default="" type="int">bgd_color</param>

10058

<return type="ressource">ressource</return>

10059

<insert>imagerotate(resource src_im, float angle, int bgd_color);</insert>

10060

<dialog title="Insert imagerotate">imagerotate(%0, %1, %2);</dialog>

10061

10062

</function>

10063

10064

<description>Set the flag to save full alpha channel information (as opposed to

10065

single-color transparency) when saving PNG images.</description>

10066

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10067

<param name="saveflag" required="1" vallist="0" default="" type="bool">saveflag</param>

10068

10069

<insert>imagesavealpha(resource image, bool saveflag);</insert>

10070

<dialog title="Insert imagesavealpha">imagesavealpha(%0, %1);</dialog>

10071

10072

</function>

10073

10074

<description>Set the brush image for line drawing</description>

10075

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10076

<param name="brush" required="1" vallist="0" default="" type="resource">brush</param>

10077

10078

<insert>imagesetbrush(resource image, resource brush);</insert>

10079

<dialog title="Insert imagesetbrush">imagesetbrush(%0, %1);</dialog>

10080

10081

</function>

10082

10083

<description>Set a single pixel</description>

10084

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10085

10086

10087

<param name="color" required="1" vallist="0" default="" type="int">color</param>

10088

10089

<insert>imagesetpixel(resource image, int x, int y, int color);</insert>

10090

<dialog title="Insert imagesetpixel">imagesetpixel(%0, %1, %2, %3);</dialog>

10091

10092

</function>

10093

10094

<description>Set the style for line drawing</description>

10095

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10096

<param name="style" required="1" vallist="0" default="" type="array">style</param>

10097

10098

<insert>imagesetstyle(resource image, array style);</insert>

10099

<dialog title="Insert imagesetstyle">imagesetstyle(%0, %1);</dialog>

10100

10101

</function>

10102

10103

<description>Set the thickness for line drawing</description>

10104

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10105

<param name="thickness" required="1" vallist="0" default="" type="int">thickness</param>

10106

10107

<insert>imagesetthickness(resource image, int thickness);</insert>

10108

<dialog title="Insert imagesetthickness">imagesetthickness(%0, %1);</dialog>

10109

10110

</function>

10111

10112

<description>Set the tile image for filling</description>

10113

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10114

10115

10116

<insert>imagesettile(resource image, resource tile);</insert>

10117

<dialog title="Insert imagesettile">imagesettile(%0, %1);</dialog>

10118

10119

</function>

10120

10121

<description>Draw a string horizontally</description>

10122

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10123

10124

10125

10126

10127

10128

10129

<insert>imagestring(resource image, int font, int x, int y, string s, int col);</insert>

10130

<dialog title="Insert imagestring">imagestring(%0, %1, %2, %3, %4, %5);</dialog>

10131

10132

</function>

10133

10134

<description>Draw a string vertically</description>

10135

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10136

10137

10138

10139

10140

10141

10142

<insert>imagestringup(resource image, int font, int x, int y, string s, int col);</insert>

10143

<dialog title="Insert imagestringup">imagestringup(%0, %1, %2, %3, %4, %5);</dialog>

10144

10145

</function>

10146

10147

<description>Get image width</description>

10148

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10149

10150

<insert>imagesx(resource image);</insert>

10151

<dialog title="Insert imagesx">imagesx(%0);</dialog>

10152

10153

</function>

10154

10155

<description>Get image height</description>

10156

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10157

10158

<insert>imagesy(resource image);</insert>

10159

<dialog title="Insert imagesy">imagesy(%0);</dialog>

10160

10161

</function>

10162

10163

<description>Convert a true color image to a palette image</description>

10164

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10165

<param name="dither" required="1" vallist="0" default="" type="bool">dither</param>

10166

<param name="ncolors" required="1" vallist="0" default="" type="int">ncolors</param>

10167

10168

<insert>imagetruecolortopalette(resource image, bool dither, int ncolors);</insert>

10169

<dialog title="Insert imagetruecolortopalette">imagetruecolortopalette(%0, %1, %2);</dialog>

10170

10171

</function>

10172

10173

<description>Give the bounding box of a text using TrueType fonts</description>

10174

10175

<param name="angle" required="1" vallist="0" default="" type="int">angle</param>

10176

<param name="fontfile" required="1" vallist="0" default="" type="string">fontfile</param>

10177

10178

<return type="array">array</return>

10179

<insert>imagettfbbox(int size, int angle, string fontfile, string text);</insert>

10180

<dialog title="Insert imagettfbbox">imagettfbbox(%0, %1, %2, %3);</dialog>

10181

10182

</function>

10183

10184

<description>Write text to the image using TrueType fonts</description>

10185

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10186

10187

<param name="angle" required="1" vallist="0" default="" type="int">angle</param>

10188

10189

10190

<param name="color" required="1" vallist="0" default="" type="int">color</param>

10191

<param name="fontfile" required="1" vallist="0" default="" type="string">fontfile</param>

10192

10193

<return type="array">array</return>

10194

<insert>imagettftext(resource image, int size, int angle, int x, int y, int color, string fontfile, string text);</insert>

10195

<dialog title="Insert imagettftext">imagettftext(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

10196

10197

</function>

10198

10199

<description>Return the image types supported by this PHP build</description>

10200

10201

<insert>imagetypes();</insert>

10202

<dialog title="Insert imagetypes">imagetypes();</dialog>

10203

10204

</function>

10205

10206

<description>Output image to browser or file</description>

10207

<param name="image" required="1" vallist="0" default="" type="resource">image</param>

10208

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

10209

<param name="foreground" required="0" vallist="0" default="" type="int">foreground</param>

10210

10211

<insert>imagewbmp(resource image [,string filename] [,int foreground]);</insert>

10212

<dialog title="Insert imagewbmp">imagewbmp(%0, %1, %2);</dialog>

10213

10214

</function>

10215

10216

<description>Embed binary IPTC data into a JPEG image</description>

10217

<param name="iptcdata" required="1" vallist="0" default="" type="string">iptcdata</param>

10218

10219

<param name="spool" required="0" vallist="0" default="" type="int">spool</param>

10220

<return type="array">array</return>

10221

<insert>iptcembed(string iptcdata, string jpeg_file_name [,int spool]);</insert>

10222

<dialog title="Insert iptcembed">iptcembed(%0, %1, %2);</dialog>

10223

10224

</function>

10225

10226

10227

Parse a binary IPTC </description>

10228

<param name="iptcblock" required="1" vallist="0" default="" type="string">iptcblock</param>

10229

<return type="array">array</return>

10230

<insert>iptcparse(string iptcblock);</insert>

10231

<dialog title="Insert iptcparse">iptcparse(%0);</dialog>

10232

10233

</function>

10234

10235

<description>Convert JPEG image file to WBMP image file</description>

10236

<param name="jpegname" required="1" vallist="0" default="" type="string">jpegname</param>

10237

<param name="wbmpname" required="1" vallist="0" default="" type="string">wbmpname</param>

10238

<param name="d_height" required="1" vallist="0" default="" type="int">d_height</param>

10239

<param name="d_width" required="1" vallist="0" default="" type="int">d_width</param>

10240

<param name="threshold" required="1" vallist="0" default="" type="int">threshold</param>

10241

10242

<insert>jpeg2wbmp(string jpegname, string wbmpname, int d_height, int d_width, int threshold);</insert>

10243

10244

10245

</function>

10246

10247

<description>Convert PNG image file to WBMP image file</description>

10248

<param name="pngname" required="1" vallist="0" default="" type="string">pngname</param>

10249

<param name="wbmpname" required="1" vallist="0" default="" type="string">wbmpname</param>

10250

<param name="d_height" required="1" vallist="0" default="" type="int">d_height</param>

10251

<param name="d_width" required="1" vallist="0" default="" type="int">d_width</param>

10252

<param name="threshold" required="1" vallist="0" default="" type="int">threshold</param>

10253

10254

<insert>png2wbmp(string pngname, string wbmpname, int d_height, int d_width, int threshold);</insert>

10255

10256

10257

</function>

10258

</group>

10259

10260

10261

10262

Convert an 8bit string to a quoted-printable string

10263

</description>

10264

<param name="string" required="1" vallist="0" default="" type="string">string</param>

10265

<return type="string">string</return>

10266

<insert>imap_8bit(string string);</insert>

10267

10268

10269

</function>

10270

10271

10272

This function returns all IMAP alert messages (if any) that have

10273

occurred during this page request or since the alert stack was

10274

reset

10275

</description>

10276

<return type="array">array</return>

10277

<insert>imap_alerts();</insert>

10278

<dialog title="Insert imap_alerts">imap_alerts();</dialog>

10279

10280

</function>

10281

10282

10283

Append a string message to a specified mailbox

10284

</description>

10285

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10286

10287

<param name="message" required="1" vallist="0" default="" type="string">message</param>

10288

<param name="options" required="0" vallist="0" default="" type="string">options</param>

10289

10290

<insert>imap_append(resource imap_stream, string mbox, string message [,string options]);</insert>

10291

<dialog title="Insert imap_append">imap_append(%0, %1, %2, %3);</dialog>

10292

10293

</function>

10294

10295

<description>Decode BASE64 encoded text</description>

10296

10297

<return type="string">string</return>

10298

<insert>imap_base64(string text);</insert>

10299

10300

10301

</function>

10302

10303

10304

Convert an 8bit string to a base64 string

10305

</description>

10306

<param name="string" required="1" vallist="0" default="" type="string">string</param>

10307

<return type="string">string</return>

10308

<insert>imap_binary(string string);</insert>

10309

<dialog title="Insert imap_binary">imap_binary(%0);</dialog>

10310

10311

</function>

10312

10313

<description>Read the message body</description>

10314

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10315

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10316

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10317

<return type="string">string</return>

10318

<insert>imap_body(resource imap_stream, int msg_number [,int options]);</insert>

10319

10320

10321

</function>

10322

10323

10324

Read the structure of a specified body section of a specific message

10325

</description>

10326

<param name="stream_id" required="1" vallist="0" default="" type="resource">stream_id</param>

10327

10328

<param name="section" required="1" vallist="0" default="" type="int">section</param>

10329

<return type="object">object</return>

10330

<insert>imap_bodystruct(resource stream_id, int msg_no, int section);</insert>

10331

<dialog title="Insert imap_bodystruct">imap_bodystruct(%0, %1, %2);</dialog>

10332

10333

</function>

10334

10335

<description>Check current mailbox</description>

10336

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10337

<return type="object">object</return>

10338

<insert>imap_check(resource imap_stream);</insert>

10339

<dialog title="Insert imap_check">imap_check(%0);</dialog>

10340

10341

</function>

10342

10343

<description>Clears flags on messages</description>

10344

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

10345

<param name="sequence" required="1" vallist="0" default="" type="string">sequence</param>

10346

10347

<param name="options" required="1" vallist="0" default="" type="string">options</param>

10348

10349

<insert>imap_clearflag_full(resource stream, string sequence, string flag, string options);</insert>

10350

<dialog title="Insert imap_clearflag_full">imap_clearflag_full(%0, %1, %2, %3);</dialog>

10351

10352

</function>

10353

10354

<description>Close an IMAP stream</description>

10355

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10356

10357

10358

<insert>imap_close(resource imap_stream [,int flag]);</insert>

10359

<dialog title="Insert imap_close">imap_close(%0, %1);</dialog>

10360

10361

</function>

10362

10363

<description>Create a new mailbox</description>

10364

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10365

10366

10367

<insert>imap_createmailbox(resource imap_stream, string mbox);</insert>

10368

<dialog title="Insert imap_createmailbox">imap_createmailbox(%0, %1);</dialog>

10369

10370

</function>

10371

10372

10373

Mark a messge for deletion from current mailbox

10374

</description>

10375

<param name="imap_stream" required="1" vallist="0" default="" type="int">imap_stream</param>

10376

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10377

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10378

10379

<insert>imap_delete(int imap_stream, int msg_number [,int options]);</insert>

10380

<dialog title="Insert imap_delete">imap_delete(%0, %1, %2);</dialog>

10381

10382

</function>

10383

10384

<description>Delete a mailbox</description>

10385

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10386

10387

10388

<insert>imap_deletemailbox(resource imap_stream, string mbox);</insert>

10389

<dialog title="Insert imap_deletemailbox">imap_deletemailbox(%0, %1);</dialog>

10390

10391

</function>

10392

10393

10394

This function returns all of the IMAP errors (if any) that have

10395

occurred during this page request or since the error stack was

10396

reset.

10397

</description>

10398

<return type="array">array</return>

10399

<insert>imap_errors();</insert>

10400

<dialog title="Insert imap_errors">imap_errors();</dialog>

10401

10402

</function>

10403

10404

<description>Delete all messages marked for deletion</description>

10405

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10406

10407

<insert>imap_expunge(resource imap_stream);</insert>

10408

<dialog title="Insert imap_expunge">imap_expunge(%0);</dialog>

10409

10410

</function>

10411

10412

10413

Read an overview of the information in the headers of the given message

10414

</description>

10415

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10416

<param name="sequence" required="1" vallist="0" default="" type="string">sequence</param>

10417

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10418

<return type="array">array</return>

10419

<insert>imap_fetch_overview(resource imap_stream, string sequence [,int options]);</insert>

10420

<dialog title="Insert imap_fetch_overview">imap_fetch_overview(%0, %1, %2);</dialog>

10421

10422

</function>

10423

10424

10425

Fetch a particular section of the body of the message

10426

</description>

10427

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10428

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10429

<param name="part_number" required="1" vallist="0" default="" type="string">part_number</param>

10430

<param name="options" required="0" vallist="0" default="" type="flags">options</param>

10431

<return type="string">string</return>

10432

<insert>imap_fetchbody(resource imap_stream, int msg_number, string part_number [,flags options]);</insert>

10433

<dialog title="Insert imap_fetchbody">imap_fetchbody(%0, %1, %2, %3);</dialog>

10434

10435

</function>

10436

10437

<description>Returns header for a message</description>

10438

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10439

<param name="msgno" required="1" vallist="0" default="" type="int">msgno</param>

10440

<param name="options" required="1" vallist="0" default="" type="int">options</param>

10441

<return type="string">string</return>

10442

<insert>imap_fetchheader(resource imap_stream, int msgno, int options);</insert>

10443

<dialog title="Insert imap_fetchheader">imap_fetchheader(%0, %1, %2);</dialog>

10444

10445

</function>

10446

10447

10448

Read the structure of a particular message

10449

</description>

10450

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10451

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10452

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10453

<return type="object">object</return>

10454

<insert>imap_fetchstructure(resource imap_stream, int msg_number [,int options]);</insert>

10455

<dialog title="Insert imap_fetchstructure">imap_fetchstructure(%0, %1, %2);</dialog>

10456

10457

</function>

10458

10459

10460

Retrieve the quota level settings, and usage statics per mailbox

10461

</description>

10462

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10463

<param name="quota_root" required="1" vallist="0" default="" type="string">quota_root</param>

10464

<return type="array">array</return>

10465

<insert>imap_get_quota(resource imap_stream, string quota_root);</insert>

10466

<dialog title="Insert imap_get_quota">imap_get_quota(%0, %1);</dialog>

10467

10468

</function>

10469

10470

10471

Retrieve the quota settings per user

10472

</description>

10473

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10474

<param name="quota_root" required="1" vallist="0" default="" type="string">quota_root</param>

10475

<return type="array">array</return>

10476

<insert>imap_get_quotaroot(resource imap_stream, string quota_root);</insert>

10477

<dialog title="Insert imap_get_quotaroot">imap_get_quotaroot(%0, %1);</dialog>

10478

10479

</function>

10480

10481

10482

Read the list of mailboxes, returning detailed information on

10483

each one

10484

</description>

10485

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10486

10487

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

10488

<return type="array">array</return>

10489

<insert>imap_getmailboxes(resource imap_stream, string ref, string pattern);</insert>

10490

<dialog title="Insert imap_getmailboxes">imap_getmailboxes(%0, %1, %2);</dialog>

10491

10492

</function>

10493

10494

<description>List all the subscribed mailboxes</description>

10495

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10496

10497

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

10498

<return type="array">array</return>

10499

<insert>imap_getsubscribed(resource imap_stream, string ref, string pattern);</insert>

10500

<dialog title="Insert imap_getsubscribed">imap_getsubscribed(%0, %1, %2);</dialog>

10501

10502

</function>

10503

10504

<description>Read the header of the message</description>

10505

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10506

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10507

<param name="fromlength" required="0" vallist="0" default="" type="int">fromlength</param>

10508

<param name="subjectlength" required="0" vallist="0" default="" type="int">subjectlength</param>

10509

<param name="defaulthost" required="0" vallist="0" default="" type="string">defaulthost</param>

10510

<return type="object">object</return>

10511

<insert>imap_headerinfo(resource imap_stream, int msg_number [,int fromlength] [,int subjectlength] [,string defaulthost]);</insert>

10512

<dialog title="Insert imap_headerinfo">imap_headerinfo(%0, %1, %2, %3, %4);</dialog>

10513

10514

</function>

10515

10516

10517

Returns headers for all messages in a mailbox

10518

</description>

10519

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10520

<return type="array">array</return>

10521

<insert>imap_headers(resource imap_stream);</insert>

10522

<dialog title="Insert imap_headers">imap_headers(%0);</dialog>

10523

10524

</function>

10525

10526

10527

This function returns the last IMAP error (if any) that occurred

10528

during this page request

10529

</description>

10530

<return type="string">string</return>

10531

<insert>imap_last_error();</insert>

10532

<dialog title="Insert imap_last_error">imap_last_error();</dialog>

10533

10534

</function>

10535

10536

<description>Read the list of mailboxes</description>

10537

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10538

10539

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

10540

<return type="array">array</return>

10541

<insert>imap_list(resource imap_stream, string ref, string pattern);</insert>

10542

10543

10544

</function>

10545

10546

10547

Read the list of mailboxes, takes a string to search for in the

10548

text of the mailbox

10549

</description>

10550

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10551

10552

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

10553

<param name="content" required="1" vallist="0" default="" type="string">content</param>

10554

<return type="array">array</return>

10555

<insert>imap_listscan(resource imap_stream, string ref, string pattern, string content);</insert>

10556

<dialog title="Insert imap_listscan">imap_listscan(%0, %1, %2, %3);</dialog>

10557

10558

</function>

10559

10560

<description>List all the subscribed mailboxes</description>

10561

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10562

10563

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

10564

<return type="array">array</return>

10565

<insert>imap_lsub(resource imap_stream, string ref, string pattern);</insert>

10566

10567

10568

</function>

10569

10570

10571

Create a MIME message based on given envelope and body sections

10572

</description>

10573

<param name="envelope" required="1" vallist="0" default="" type="array">envelope</param>

10574

10575

<return type="string">string</return>

10576

<insert>imap_mail_compose(array envelope, array body);</insert>

10577

<dialog title="Insert imap_mail_compose">imap_mail_compose(%0, %1);</dialog>

10578

10579

</function>

10580

10581

<description>Copy specified messages to a mailbox</description>

10582

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10583

<param name="msglist" required="1" vallist="0" default="" type="string">msglist</param>

10584

10585

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10586

10587

<insert>imap_mail_copy(resource imap_stream, string msglist, string mbox [,int options]);</insert>

10588

10589

10590

</function>

10591

10592

<description>Move specified messages to a mailbox</description>

10593

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10594

<param name="msglist" required="1" vallist="0" default="" type="string">msglist</param>

10595

10596

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10597

10598

<insert>imap_mail_move(resource imap_stream, string msglist, string mbox [,int options]);</insert>

10599

10600

10601

</function>

10602

10603

10604

Send an email message

10605

</description>

10606

10607

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

10608

<param name="message" required="1" vallist="0" default="" type="string">message</param>

10609

<param name="additional_headers" required="0" vallist="0" default="" type="string">additional_headers</param>

10610

10611

10612

<param name="rpath" required="0" vallist="0" default="" type="string">rpath</param>

10613

<return type="string">string</return>

10614

<insert>imap_mail(string to, string subject, string message [,string additional_headers] [,string cc] [,string bcc] [,string rpath]);</insert>

10615

10616

10617

</function>

10618

10619

<description>Get information about the current mailbox</description>

10620

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10621

<return type="object">object</return>

10622

<insert>imap_mailboxmsginfo(resource imap_stream);</insert>

10623

<dialog title="Insert imap_mailboxmsginfo">imap_mailboxmsginfo(%0);</dialog>

10624

10625

</function>

10626

10627

<description>Decode MIME header elements</description>

10628

10629

<return type="array">array</return>

10630

<insert>imap_mime_header_decode(string text);</insert>

10631

<dialog title="Insert imap_mime_header_decode">imap_mime_header_decode(%0);</dialog>

10632

10633

</function>

10634

10635

10636

This function returns the message sequence number for the given

10637

UID

10638

</description>

10639

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10640

10641

10642

<insert>imap_msgno(resource imap_stream, int uid);</insert>

10643

<dialog title="Insert imap_msgno">imap_msgno(%0, %1);</dialog>

10644

10645

</function>

10646

10647

10648

Gives the number of messages in the current mailbox

10649

</description>

10650

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10651

10652

<insert>imap_num_msg(resource imap_stream);</insert>

10653

10654

10655

</function>

10656

10657

<description>Gives the number of recent messages in current

10658

mailbox</description>

10659

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10660

10661

<insert>imap_num_recent(resource imap_stream);</insert>

10662

<dialog title="Insert imap_num_recent">imap_num_recent(%0);</dialog>

10663

10664

</function>

10665

10666

<description>Open an IMAP stream to a mailbox</description>

10667

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

10668

<param name="username" required="1" vallist="0" default="" type="string">username</param>

10669

<param name="password" required="1" vallist="0" default="" type="string">password</param>

10670

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10671

<return type="resource">resource</return>

10672

<insert>imap_open(string mailbox, string username, string password [,int options]);</insert>

10673

10674

10675

</function>

10676

10677

<description>Check if the IMAP stream is still active</description>

10678

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10679

10680

<insert>imap_ping(resource imap_stream);</insert>

10681

10682

10683

</function>

10684

10685

<description>Convert a quoted-printable string to an 8 bit

10686

string</description>

10687

<param name="string" required="1" vallist="0" default="" type="string">string</param>

10688

<return type="string">string</return>

10689

<insert>imap_qprint(string string);</insert>

10690

<dialog title="Insert imap_qprint">imap_qprint(%0);</dialog>

10691

10692

</function>

10693

10694

<description>Rename an old mailbox to new mailbox</description>

10695

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10696

10697

10698

10699

<insert>imap_renamemailbox(resource imap_stream, string old_mbox, string new_mbox);</insert>

10700

<dialog title="Insert imap_renamemailbox">imap_renamemailbox(%0, %1, %2);</dialog>

10701

10702

</function>

10703

10704

<description>Reopen IMAP stream to new mailbox</description>

10705

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10706

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

10707

<param name="options" required="0" vallist="0" default="" type="string">options</param>

10708

10709

<insert>imap_reopen(resource imap_stream, string mailbox [,string options]);</insert>

10710

<dialog title="Insert imap_reopen">imap_reopen(%0, %1, %2);</dialog>

10711

10712

</function>

10713

10714

<description>Parses an address string</description>

10715

<param name="address" required="1" vallist="0" default="" type="string">address</param>

10716

<param name="default_host" required="1" vallist="0" default="" type="string">default_host</param>

10717

<return type="array">array</return>

10718

<insert>imap_rfc822_parse_adrlist(string address, string default_host);</insert>

10719

<dialog title="Insert imap_rfc822_parse_adrlist">imap_rfc822_parse_adrlist(%0, %1);</dialog>

10720

10721

</function>

10722

10723

<description>Parse mail headers from a string</description>

10724

<param name="headers" required="1" vallist="0" default="" type="string">headers</param>

10725

<param name="defaulthost" required="0" vallist="0" default="" type="string">defaulthost</param>

10726

<return type="object">object</return>

10727

<insert>imap_rfc822_parse_headers(string headers [,string defaulthost]);</insert>

10728

<dialog title="Insert imap_rfc822_parse_headers">imap_rfc822_parse_headers(%0, %1);</dialog>

10729

10730

</function>

10731

10732

10733

Returns a properly formatted email address given the mailbox,

10734

host, and personal info.

10735

</description>

10736

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

10737

10738

<param name="personal" required="1" vallist="0" default="" type="string">personal</param>

10739

<return type="string">string</return>

10740

<insert>imap_rfc822_write_address(string mailbox, string host, string personal);</insert>

10741

<dialog title="Insert imap_rfc822_write_address">imap_rfc822_write_address(%0, %1, %2);</dialog>

10742

10743

</function>

10744

10745

10746

This function returns an array of messages matching the given

10747

search criteria

10748

</description>

10749

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10750

<param name="criteria" required="1" vallist="0" default="" type="string">criteria</param>

10751

<param name="options" required="1" vallist="0" default="" type="int">options</param>

10752

<return type="array">array</return>

10753

<insert>imap_search(resource imap_stream, string criteria, int options);</insert>

10754

<dialog title="Insert imap_search">imap_search(%0, %1, %2);</dialog>

10755

10756

</function>

10757

10758

<description>Sets a quota for a given mailbox</description>

10759

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10760

<param name="quota_root" required="1" vallist="0" default="" type="string">quota_root</param>

10761

<param name="quota_limit" required="1" vallist="0" default="" type="int">quota_limit</param>

10762

10763

<insert>imap_set_quota(resource imap_stream, string quota_root, int quota_limit);</insert>

10764

<dialog title="Insert imap_set_quota">imap_set_quota(%0, %1, %2);</dialog>

10765

10766

</function>

10767

10768

10769

Sets the ACL for a giving mailbox

10770

</description>

10771

<param name="stream_id" required="1" vallist="0" default="" type="resource">stream_id</param>

10772

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

10773

10774

<param name="rights" required="1" vallist="0" default="" type="string">rights</param>

10775

10776

<insert>imap_setacl(resource stream_id, string mailbox, string id, string rights);</insert>

10777

<dialog title="Insert imap_setacl">imap_setacl(%0, %1, %2, %3);</dialog>

10778

10779

</function>

10780

10781

<description>Sets flags on messages</description>

10782

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

10783

<param name="sequence" required="1" vallist="0" default="" type="string">sequence</param>

10784

10785

<param name="options" required="1" vallist="0" default="" type="string">options</param>

10786

10787

<insert>imap_setflag_full(resource stream, string sequence, string flag, string options);</insert>

10788

<dialog title="Insert imap_setflag_full">imap_setflag_full(%0, %1, %2, %3);</dialog>

10789

10790

</function>

10791

10792

<description>Sort an array of message headers</description>

10793

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

10794

<param name="criteria" required="1" vallist="0" default="" type="int">criteria</param>

10795

<param name="reverse" required="1" vallist="0" default="" type="int">reverse</param>

10796

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10797

<param name="search_criteria" required="0" vallist="0" default="" type="string">search_criteria</param>

10798

<return type="array">array</return>

10799

<insert>imap_sort(resource stream, int criteria, int reverse [,int options] [,string search_criteria]);</insert>

10800

10801

10802

</function>

10803

10804

10805

This function returns status information on a mailbox other than

10806

the current one

10807

</description>

10808

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10809

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

10810

<param name="options" required="1" vallist="0" default="" type="int">options</param>

10811

<return type="object">object</return>

10812

<insert>imap_status(resource imap_stream, string mailbox, int options);</insert>

10813

<dialog title="Insert imap_status">imap_status(%0, %1, %2);</dialog>

10814

10815

</function>

10816

10817

<description>Subscribe to a mailbox</description>

10818

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10819

10820

10821

<insert>imap_subscribe(resource imap_stream, string mbox);</insert>

10822

<dialog title="Insert imap_subscribe">imap_subscribe(%0, %1);</dialog>

10823

10824

</function>

10825

10826

10827

Return threaded by REFERENCES tree

10828

</description>

10829

<param name="stream_id" required="1" vallist="0" default="" type="resource">stream_id</param>

10830

<param name="options" required="0" vallist="0" default="" type="int">options</param>

10831

<return type="array">array</return>

10832

<insert>imap_thread(resource stream_id [,int options]);</insert>

10833

<dialog title="Insert imap_thread">imap_thread(%0, %1);</dialog>

10834

10835

</function>

10836

10837

10838

This function returns the UID for the given message sequence

10839

number

10840

</description>

10841

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10842

<param name="msgno" required="1" vallist="0" default="" type="int">msgno</param>

10843

10844

<insert>imap_uid(resource imap_stream, int msgno);</insert>

10845

10846

10847

</function>

10848

10849

10850

Unmark the message which is marked deleted

10851

</description>

10852

<param name="imap_stream" required="1" vallist="0" default="" type="resource">imap_stream</param>

10853

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

10854

10855

<insert>imap_undelete(resource imap_stream, int msg_number);</insert>

10856

<dialog title="Insert imap_undelete">imap_undelete(%0, %1);</dialog>

10857

10858

</function>

10859

10860

<description>Unsubscribe from a mailbox</description>

10861

<param name="imap_stream" required="1" vallist="0" default="" type="string">imap_stream</param>

10862

10863

10864

<insert>imap_unsubscribe(string imap_stream, string mbox);</insert>

10865

<dialog title="Insert imap_unsubscribe">imap_unsubscribe(%0, %1);</dialog>

10866

10867

</function>

10868

10869

10870

Decodes a modified UTF-7 encoded string.

10871

</description>

10872

10873

<return type="string">string</return>

10874

<insert>imap_utf7_decode(string text);</insert>

10875

<dialog title="Insert imap_utf7_decode">imap_utf7_decode(%0);</dialog>

10876

10877

</function>

10878

10879

10880

Converts 8bit data to modified UTF-7 text.

10881

</description>

10882

10883

<return type="string">string</return>

10884

<insert>imap_utf7_encode(string data);</insert>

10885

<dialog title="Insert imap_utf7_encode">imap_utf7_encode(%0);</dialog>

10886

10887

</function>

10888

10889

10890

Converts text to UTF8

10891

</description>

10892

10893

<return type="string">string</return>

10894

<insert>imap_utf8(string text);</insert>

10895

10896

10897

</function>

10898

</group>

10899

10900

10901

<description>Set/get the various assert flags</description>

10902

10903

<param name="value" required="0" vallist="0" default="" type="mixed">value</param>

10904

<return type="mixed">mixed</return>

10905

<insert>assert_options(int what [,mixed value]);</insert>

10906

<dialog title="Insert assert_options">assert_options(%0, %1);</dialog>

10907

10908

</function>

10909

10910

<description>Checks if assertion is </description>

10911

<param name="assertion" required="1" vallist="0" default="" type="mixed">assertion</param>

10912

10913

<insert>assert(mixed assertion);</insert>

10914

<dialog title="Insert assert">assert(%0);</dialog>

10915

10916

</function>

10917

10918

<description>Loads a PHP extension at runtime</description>

10919

<param name="library" required="1" vallist="0" default="" type="string">library</param>

10920

10921

<insert>dl(string library);</insert>

10922

10923

10924

</function>

10925

10926

<description>Find out whether an extension is loaded</description>

10927

10928

10929

<insert>extension_loaded(string name);</insert>

10930

<dialog title="Insert extension_loaded">extension_loaded(%0);</dialog>

10931

10932

</function>

10933

10934

10935

Gets the value of a PHP configuration option

10936

</description>

10937

<param name="varname" required="1" vallist="0" default="" type="string">varname</param>

10938

<return type="string">string</return>

10939

<insert>get_cfg_var(string varname);</insert>

10940

10941

10942

</function>

10943

10944

10945

Gets the name of the owner of the current PHP script

10946

</description>

10947

<return type="string">string</return>

10948

<insert>get_current_user();</insert>

10949

<dialog title="Insert get_current_user">get_current_user();</dialog>

10950

10951

</function>

10952

10953

10954

Returns an associative array with the names of all the constants

10955

and their values

10956

</description>

10957

<return type="array">array</return>

10958

<insert>get_defined_constants();</insert>

10959

<dialog title="Insert get_defined_constants">get_defined_constants();</dialog>

10960

10961

</function>

10962

10963

10964

Returns an array with the names of the functions of a module

10965

</description>

10966

<param name="module_name" required="1" vallist="0" default="" type="string">module_name</param>

10967

<return type="array">array</return>

10968

<insert>get_extension_funcs(string module_name);</insert>

10969

<dialog title="Insert get_extension_funcs">get_extension_funcs(%0);</dialog>

10970

10971

</function>

10972

10973

10974

Returns an array with the names of included or required files

10975

</description>

10976

<return type="array">array</return>

10977

<insert>get_included_files();</insert>

10978

<dialog title="Insert get_included_files">get_included_files();</dialog>

10979

10980

</function>

10981

10982

10983

Returns an array with the names of all modules compiled and

10984

loaded

10985

</description>

10986

<return type="array">array</return>

10987

<insert>get_loaded_extensions();</insert>

10988

<dialog title="Insert get_loaded_extensions">get_loaded_extensions();</dialog>

10989

10990

</function>

10991

10992

10993

Gets the current active configuration setting of magic quotes gpc

10994

</description>

10995

10996

<insert>get_magic_quotes_gpc();</insert>

10997

<dialog title="Insert get_magic_quotes_gpc">get_magic_quotes_gpc();</dialog>

10998

10999

</function>

11000

11001

11002

Gets the current active configuration setting of

11003

magic_quotes_runtime

11004

</description>

11005

11006

<insert>get_magic_quotes_runtime();</insert>

11007

<dialog title="Insert get_magic_quotes_runtime">get_magic_quotes_runtime();</dialog>

11008

11009

</function>

11010

11011

<description>Gets the value of an environment variable</description>

11012

<param name="varname" required="1" vallist="0" default="" type="string">varname</param>

11013

<return type="string">string</return>

11014

<insert>getenv(string varname);</insert>

11015

<dialog title="Insert getenv">getenv(%0);</dialog>

11016

11017

</function>

11018

11019

<description>Gets time of last page modification</description>

11020

11021

<insert>getlastmod();</insert>

11022

<dialog title="Insert getlastmod">getlastmod();</dialog>

11023

11024

</function>

11025

11026

<description>Get PHP script owner's GID</description>

11027

11028

<insert>getmygid();</insert>

11029

<dialog title="Insert getmygid">getmygid();</dialog>

11030

11031

</function>

11032

11033

<description>Gets the inode of the current script</description>

11034

11035

<insert>getmyinode();</insert>

11036

<dialog title="Insert getmyinode">getmyinode();</dialog>

11037

11038

</function>

11039

11040

<description>Gets PHP's process ID</description>

11041

11042

<insert>getmypid();</insert>

11043

<dialog title="Insert getmypid">getmypid();</dialog>

11044

11045

</function>

11046

11047

<description>Gets PHP script owner's UID</description>

11048

11049

<insert>getmyuid();</insert>

11050

<dialog title="Insert getmyuid">getmyuid();</dialog>

11051

11052

</function>

11053

11054

<description>Gets options from the command line argument list</description>

11055

<param name="options" required="1" vallist="0" default="" type="string">options</param>

11056

<return type="string">string</return>

11057

<insert>getopt(string options);</insert>

11058

<dialog title="Insert getopt">getopt(%0);</dialog>

11059

11060

</function>

11061

11062

<description>Gets the current resource usages</description>

11063

11064

<return type="array">array</return>

11065

<insert>getrusage([int who]);</insert>

11066

<dialog title="Insert getrusage">getrusage(%0);</dialog>

11067

11068

</function>

11069

11070

<description>Gets all configuration options</description>

11071

<param name="extension" required="0" vallist="0" default="" type="string">extension</param>

11072

<return type="array">array</return>

11073

<insert>ini_get_all([string extension]);</insert>

11074

11075

11076

</function>

11077

11078

<description>Gets the value of a configuration option</description>

11079

<param name="varname" required="1" vallist="0" default="" type="string">varname</param>

11080

<return type="string">string</return>

11081

<insert>ini_get(string varname);</insert>

11082

11083

11084

</function>

11085

11086

<description>Restores the value of a configuration option</description>

11087

<param name="varname" required="1" vallist="0" default="" type="string">varname</param>

11088

<return type="string">string</return>

11089

<insert>ini_restore(string varname);</insert>

11090

<dialog title="Insert ini_restore">ini_restore(%0);</dialog>

11091

11092

</function>

11093

11094

<description>Sets the value of a configuration option</description>

11095

<param name="varname" required="1" vallist="0" default="" type="string">varname</param>

11096

<param name="newvalue" required="1" vallist="0" default="" type="string">newvalue</param>

11097

<return type="string">string</return>

11098

<insert>ini_set(string varname, string newvalue);</insert>

11099

11100

11101

</function>

11102

11103

<description>Return a list of .ini files parsed from the additional ini dir</description>

11104

<return type="string">string</return>

11105

<insert>php_ini_scanned_files();</insert>

11106

<dialog title="Insert php_ini_scanned_files">php_ini_scanned_files();</dialog>

11107

11108

</function>

11109

11110

11111

<return type="string">string</return>

11112

11113

11114

11115

</function>

11116

11117

11118

Returns the type of interface between web server and PHP

11119

</description>

11120

<return type="string">string</return>

11121

11122

11123

11124

</function>

11125

11126

11127

Returns information about the operating system PHP was built on

11128

</description>

11129

<return type="string">string</return>

11130

<insert>php_uname();</insert>

11131

<dialog title="Insert php_uname">php_uname();</dialog>

11132

11133

</function>

11134

11135

<description>Prints out the credits for PHP</description>

11136

11137

11138

<insert>phpcredits([int flag]);</insert>

11139

<dialog title="Insert phpcredits">phpcredits(%0);</dialog>

11140

11141

</function>

11142

11143

<description>Outputs lots of PHP information</description>

11144

11145

11146

<insert>phpinfo([int what]);</insert>

11147

<dialog title="Insert phpinfo">phpinfo(%0);</dialog>

11148

11149

</function>

11150

11151

<description>Gets the current PHP version</description>

11152

<return type="string">string</return>

11153

<insert>phpversion();</insert>

11154

<dialog title="Insert phpversion">phpversion();</dialog>

11155

11156

</function>

11157

11158

<description>Sets the value of an environment variable</description>

11159

<param name="setting" required="1" vallist="0" default="" type="string">setting</param>

11160

11161

<insert>putenv(string setting);</insert>

11162

<dialog title="Insert putenv">putenv(%0);</dialog>

11163

11164

</function>

11165

11166

11167

Sets the current active configuration setting of

11168

magic_quotes_runtime

11169

</description>

11170

<param name="new_setting" required="1" vallist="0" default="" type="int">new_setting</param>

11171

11172

<insert>set_magic_quotes_runtime(int new_setting);</insert>

11173

<dialog title="Insert set_magic_quotes_runtime">set_magic_quotes_runtime(%0);</dialog>

11174

11175

</function>

11176

11177

<description>Limits the maximum execution time</description>

11178

<param name="seconds" required="1" vallist="0" default="" type="int">seconds</param>

11179

11180

<insert>set_time_limit(int seconds);</insert>

11181

<dialog title="Insert set_time_limit">set_time_limit(%0);</dialog>

11182

11183

</function>

11184

11185

11186

Compares two "PHP-standardized" version number strings

11187

</description>

11188

<param name="version1" required="1" vallist="0" default="" type="string">version1</param>

11189

<param name="version2" required="1" vallist="0" default="" type="string">version2</param>

11190

<param name="

11191

operator

11192

" required="0" vallist="0" default="" type="string">

11193

operator

11194

</param>

11195

11196

<insert>version_compare(string version1, string version2 [,string

11197

operator

11198

]);</insert>

11199

<dialog title="Insert version_compare">version_compare(%0, %1, %2);</dialog>

11200

11201

</function>

11202

11203

11204

<return type="string">string</return>

11205

11206

11207

11208

</function>

11209

11210

<description>Gets the version of the current Zend engine</description>

11211

<return type="string">string</return>

11212

<insert>zend_version();</insert>

11213

<dialog title="Insert zend_version">zend_version();</dialog>

11214

11215

</function>

11216

</group>

11217

11218

11219

<description>Switch autocommit on or off</description>

11220

11221

11222

<insert>ingres_autocommit([resource link]);</insert>

11223

<dialog title="Insert ingres_autocommit">ingres_autocommit(%0);</dialog>

11224

11225

</function>

11226

11227

<description>Close an Ingres II database connection</description>

11228

11229

11230

<insert>ingres_close([resource link]);</insert>

11231

<dialog title="Insert ingres_close">ingres_close(%0);</dialog>

11232

11233

</function>

11234

11235

<description>Commit a transaction</description>

11236

11237

11238

<insert>ingres_commit([resource link]);</insert>

11239

<dialog title="Insert ingres_commit">ingres_commit(%0);</dialog>

11240

11241

</function>

11242

11243

11244

Open a connection to an Ingres II database

11245

</description>

11246

<param name="database" required="0" vallist="0" default="" type="string">database</param>

11247

<param name="username" required="0" vallist="0" default="" type="string">username</param>

11248

<param name="password" required="0" vallist="0" default="" type="string">password</param>

11249

<return type="resource">resource</return>

11250

<insert>ingres_connect([string database] [,string username] [,string password]);</insert>

11251

<dialog title="Insert ingres_connect">ingres_connect(%0, %1, %2);</dialog>

11252

11253

</function>

11254

11255

<description>Fetch a row of result into an array</description>

11256

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

11257

11258

<return type="array">array</return>

11259

<insert>ingres_fetch_array([int result_type] [,resource link]);</insert>

11260

<dialog title="Insert ingres_fetch_array">ingres_fetch_array(%0, %1);</dialog>

11261

11262

</function>

11263

11264

<description>Fetch a row of result into an object.</description>

11265

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

11266

11267

<return type="object">object</return>

11268

<insert>ingres_fetch_object([int result_type] [,resource link]);</insert>

11269

<dialog title="Insert ingres_fetch_object">ingres_fetch_object(%0, %1);</dialog>

11270

11271

</function>

11272

11273

11274

Fetch a row of result into an enumerated array

11275

</description>

11276

11277

<return type="array">array</return>

11278

<insert>ingres_fetch_row([resource link]);</insert>

11279

<dialog title="Insert ingres_fetch_row">ingres_fetch_row(%0);</dialog>

11280

11281

</function>

11282

11283

<description>Get the length of a field</description>

11284

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11285

11286

11287

<insert>ingres_field_length(int index [,resource link]);</insert>

11288

<dialog title="Insert ingres_field_length">ingres_field_length(%0, %1);</dialog>

11289

11290

</function>

11291

11292

<description>Get the name of a field in a query result.</description>

11293

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11294

11295

<return type="string">string</return>

11296

<insert>ingres_field_name(int index [,resource link]);</insert>

11297

<dialog title="Insert ingres_field_name">ingres_field_name(%0, %1);</dialog>

11298

11299

</function>

11300

11301

<description>Test if a field is nullable</description>

11302

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11303

11304

11305

<insert>ingres_field_nullable(int index [,resource link]);</insert>

11306

<dialog title="Insert ingres_field_nullable">ingres_field_nullable(%0, %1);</dialog>

11307

11308

</function>

11309

11310

<description>Get the precision of a field</description>

11311

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11312

11313

11314

<insert>ingres_field_precision(int index [,resource link]);</insert>

11315

<dialog title="Insert ingres_field_precision">ingres_field_precision(%0, %1);</dialog>

11316

11317

</function>

11318

11319

<description>Get the scale of a field</description>

11320

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11321

11322

11323

<insert>ingres_field_scale(int index [,resource link]);</insert>

11324

<dialog title="Insert ingres_field_scale">ingres_field_scale(%0, %1);</dialog>

11325

11326

</function>

11327

11328

11329

Get the type of a field in a query result

11330

</description>

11331

<param name="index" required="1" vallist="0" default="" type="int">index</param>

11332

11333

<return type="string">string</return>

11334

<insert>ingres_field_type(int index [,resource link]);</insert>

11335

<dialog title="Insert ingres_field_type">ingres_field_type(%0, %1);</dialog>

11336

11337

</function>

11338

11339

11340

Get the number of fields returned by the last query

11341

</description>

11342

11343

11344

<insert>ingres_num_fields([resource link]);</insert>

11345

<dialog title="Insert ingres_num_fields">ingres_num_fields(%0);</dialog>

11346

11347

</function>

11348

11349

11350

Get the number of rows affected or returned by the last query

11351

</description>

11352

11353

11354

<insert>ingres_num_rows([resource link]);</insert>

11355

<dialog title="Insert ingres_num_rows">ingres_num_rows(%0);</dialog>

11356

11357

</function>

11358

11359

11360

Open a persistent connection to an Ingres II database

11361

</description>

11362

<param name="database" required="0" vallist="0" default="" type="string">database</param>

11363

<param name="username" required="0" vallist="0" default="" type="string">username</param>

11364

<param name="password" required="0" vallist="0" default="" type="string">password</param>

11365

<return type="resource">resource</return>

11366

<insert>ingres_pconnect([string database] [,string username] [,string password]);</insert>

11367

<dialog title="Insert ingres_pconnect">ingres_pconnect(%0, %1, %2);</dialog>

11368

11369

</function>

11370

11371

<description>Send a SQL query to Ingres II</description>

11372

<param name="query" required="1" vallist="0" default="" type="string">query</param>

11373

11374

11375

<insert>ingres_query(string query [,resource link]);</insert>

11376

<dialog title="Insert ingres_query">ingres_query(%0, %1);</dialog>

11377

11378

</function>

11379

11380

<description>Roll back a transaction</description>

11381

11382

11383

<insert>ingres_rollback([resource link]);</insert>

11384

<dialog title="Insert ingres_rollback">ingres_rollback(%0);</dialog>

11385

11386

</function>

11387

</group>

11388

11389

11390

11391

Set channel mode flags for user

11392

</description>

11393

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11394

<param name="channel" required="1" vallist="0" default="" type="string">channel</param>

11395

11396

11397

11398

<insert>ircg_channel_mode(resource connection, string channel, string mode_spec, string nick);</insert>

11399

<dialog title="Insert ircg_channel_mode">ircg_channel_mode(%0, %1, %2, %3);</dialog>

11400

11401

</function>

11402

11403

11404

Close connection to server

11405

</description>

11406

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11407

<param name="reason" required="1" vallist="0" default="" type="string">reason</param>

11408

11409

<insert>ircg_disconnect(resource connection, string reason);</insert>

11410

<dialog title="Insert ircg_disconnect">ircg_disconnect(%0, %1);</dialog>

11411

11412

</function>

11413

11414

11415

Returns the error from previous IRCG operation

11416

</description>

11417

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11418

<return type="array">array</return>

11419

<insert>ircg_fetch_error_msg(resource connection);</insert>

11420

<dialog title="Insert ircg_fetch_error_msg">ircg_fetch_error_msg(%0);</dialog>

11421

11422

</function>

11423

11424

11425

Get username for connection

11426

</description>

11427

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11428

<return type="string">string</return>

11429

<insert>ircg_get_username(resource connection);</insert>

11430

<dialog title="Insert ircg_get_username">ircg_get_username(%0);</dialog>

11431

11432

</function>

11433

11434

11435

Encodes HTML preserving output

11436

</description>

11437

<param name="html_string" required="1" vallist="0" default="" type="string">html_string</param>

11438

11439

<insert>ircg_html_encode(string html_string);</insert>

11440

<dialog title="Insert ircg_html_encode">ircg_html_encode(%0);</dialog>

11441

11442

</function>

11443

11444

11445

Add a user to your ignore list on a server

11446

</description>

11447

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11448

11449

11450

<insert>ircg_ignore_add(resource connection, string nick);</insert>

11451

<dialog title="Insert ircg_ignore_add">ircg_ignore_add(%0, %1);</dialog>

11452

11453

</function>

11454

11455

11456

Remove a user from your ignore list on a server

11457

</description>

11458

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11459

11460

11461

<insert>ircg_ignore_del(resource connection, string nick);</insert>

11462

<dialog title="Insert ircg_ignore_del">ircg_ignore_del(%0, %1);</dialog>

11463

11464

</function>

11465

11466

11467

Check connection status

11468

</description>

11469

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11470

11471

<insert>ircg_is_conn_alive(resource connection);</insert>

11472

<dialog title="Insert ircg_is_conn_alive">ircg_is_conn_alive(%0);</dialog>

11473

11474

</function>

11475

11476

11477

Join a channel on a connected server

11478

</description>

11479

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11480

<param name="channel" required="1" vallist="0" default="" type="string">channel</param>

11481

11482

11483

<insert>ircg_join(resource connection, string channel [,string key]);</insert>

11484

11485

11486

</function>

11487

11488

11489

Kick a user out of a channel on server

11490

</description>

11491

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11492

<param name="channel" required="1" vallist="0" default="" type="string">channel</param>

11493

11494

<param name="reason" required="1" vallist="0" default="" type="string">reason</param>

11495

11496

<insert>ircg_kick(resource connection, string channel, string nick, string reason);</insert>

11497

11498

11499

</function>

11500

11501

11502

Check for the existence of a format message set

11503

</description>

11504

11505

11506

<insert>ircg_lookup_format_messages(string name);</insert>

11507

<dialog title="Insert ircg_lookup_format_messages">ircg_lookup_format_messages(%0);</dialog>

11508

11509

</function>

11510

11511

11512

Send message to channel or user on server

11513

</description>

11514

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11515

<param name="recipient" required="1" vallist="0" default="" type="string">recipient</param>

11516

<param name="message" required="1" vallist="0" default="" type="string">message</param>

11517

<param name="suppress" required="0" vallist="0" default="" type="boolean">suppress</param>

11518

11519

<insert>ircg_msg(resource connection, string recipient, string message [,boolean suppress]);</insert>

11520

11521

11522

</function>

11523

11524

11525

Change nickname on server

11526

</description>

11527

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11528

11529

11530

<insert>ircg_nick(resource connection, string nick);</insert>

11531

11532

11533

</function>

11534

11535

11536

Encode special characters in nickname to be IRC-compliant

11537

</description>

11538

11539

<return type="string">string</return>

11540

<insert>ircg_nickname_escape(string nick);</insert>

11541

<dialog title="Insert ircg_nickname_escape">ircg_nickname_escape(%0);</dialog>

11542

11543

</function>

11544

11545

11546

Decodes encoded nickname

11547

</description>

11548

11549

<return type="string">string</return>

11550

<insert>ircg_nickname_unescape(string nick);</insert>

11551

<dialog title="Insert ircg_nickname_unescape">ircg_nickname_unescape(%0);</dialog>

11552

11553

</function>

11554

11555

11556

Send a notice to a user on server

11557

</description>

11558

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11559

<param name="message" required="1" vallist="0" default="" type="string">message</param>

11560

11561

<insert>ircg_notice(resource connection, string message);</insert>

11562

<dialog title="Insert ircg_notice">ircg_notice(%0, %1);</dialog>

11563

11564

</function>

11565

11566

11567

Leave a channel on server

11568

</description>

11569

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11570

<param name="channel" required="1" vallist="0" default="" type="string">channel</param>

11571

11572

<insert>ircg_part(resource connection, string channel);</insert>

11573

11574

11575

</function>

11576

11577

11578

Connect to an IRC server

11579

</description>

11580

<param name="username" required="1" vallist="0" default="" type="string">username</param>

11581

<param name="server_ip" required="0" vallist="0" default="" type="string">server_ip</param>

11582

<param name="server_port" required="0" vallist="0" default="" type="int">server_port</param>

11583

<param name="msg_format" required="0" vallist="0" default="" type="string">msg_format</param>

11584

<param name="ctcp_messages" required="0" vallist="0" default="" type="array">ctcp_messages</param>

11585

<param name="user_settings" required="0" vallist="0" default="" type="array">user_settings</param>

11586

<return type="resource">resource</return>

11587

<insert>ircg_pconnect(string username [,string server_ip] [,int server_port] [,string msg_format] [,array ctcp_messages] [,array user_settings]);</insert>

11588

<dialog title="Insert ircg_pconnect">ircg_pconnect(%0, %1, %2, %3, %4, %5);</dialog>

11589

11590

</function>

11591

11592

11593

Register a format message set

11594

</description>

11595

11596

<param name="messages" required="1" vallist="0" default="" type="array">messages</param>

11597

11598

<insert>ircg_register_format_messages(string name, array messages);</insert>

11599

<dialog title="Insert ircg_register_format_messages">ircg_register_format_messages(%0, %1);</dialog>

11600

11601

</function>

11602

11603

11604

Set current connection for output

11605

</description>

11606

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11607

11608

<insert>ircg_set_current(resource connection);</insert>

11609

<dialog title="Insert ircg_set_current">ircg_set_current(%0);</dialog>

11610

11611

</function>

11612

11613

11614

Set logfile for connection

11615

</description>

11616

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11617

11618

11619

<insert>ircg_set_file(resource connection, string path);</insert>

11620

11621

11622

</function>

11623

11624

11625

Set action to be executed when connection dies

11626

</description>

11627

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11628

11629

11630

11631

11632

<insert>ircg_set_on_die(resource connection, string host, int port, string data);</insert>

11633

11634

11635

</function>

11636

11637

11638

Set topic for channel on server

11639

</description>

11640

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11641

<param name="channel" required="1" vallist="0" default="" type="string">channel</param>

11642

<param name="new_topic" required="1" vallist="0" default="" type="string">new_topic</param>

11643

11644

<insert>ircg_topic(resource connection, string channel, string new_topic);</insert>

11645

<dialog title="Insert ircg_topic">ircg_topic(%0, %1, %2);</dialog>

11646

11647

</function>

11648

11649

11650

Query server for user information

11651

</description>

11652

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

11653

11654

11655

<insert>ircg_whois(resource connection, string nick);</insert>

11656

<dialog title="Insert ircg_whois">ircg_whois(%0, %1);</dialog>

11657

11658

</function>

11659

</group>

11660

11661

11662

<description>Clear last Java exception</description>

11663

11664

<insert>java_last_exception_clear();</insert>

11665

<dialog title="Insert java_last_exception_clear">java_last_exception_clear();</dialog>

11666

11667

</function>

11668

11669

<description>Get last Java exception</description>

11670

<return type="exception">exception</return>

11671

<insert>java_last_exception_get();</insert>

11672

<dialog title="Insert java_last_exception_get">java_last_exception_get();</dialog>

11673

11674

</function>

11675

</group>

11676

11677

11678

11679

Translate 8859 characters to t61 characters

11680

</description>

11681

<param name="value" required="1" vallist="0" default="" type="string">value</param>

11682

<return type="string">string</return>

11683

<insert>ldap_8859_to_t61(string value);</insert>

11684

11685

11686

</function>

11687

11688

<description>Add entries to LDAP directory</description>

11689

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11690

11691

<param name="entry" required="1" vallist="0" default="" type="array">entry</param>

11692

11693

<insert>ldap_add(resource link_identifier, string dn, array entry);</insert>

11694

11695

11696

</function>

11697

11698

<description>Bind to LDAP directory</description>

11699

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11700

11701

<param name="bind_password" required="0" vallist="0" default="" type="string">bind_password</param>

11702

11703

<insert>ldap_bind(resource link_identifier [,string bind_rdn] [,string bind_password]);</insert>

11704

11705

11706

</function>

11707

11708

<description>Close link to LDAP server</description>

11709

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11710

11711

<insert>ldap_close(resource link_identifier);</insert>

11712

<dialog title="Insert ldap_close">ldap_close(%0);</dialog>

11713

11714

</function>

11715

11716

<description>Compare value of attribute found in entry specified with DN</description>

11717

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11718

11719

<param name="attribute" required="1" vallist="0" default="" type="string">attribute</param>

11720

<param name="value" required="1" vallist="0" default="" type="string">value</param>

11721

11722

<insert>ldap_compare(resource link_identifier, string dn, string attribute, string value);</insert>

11723

<dialog title="Insert ldap_compare">ldap_compare(%0, %1, %2, %3);</dialog>

11724

11725

</function>

11726

11727

<description>Connect to an LDAP server</description>

11728

<param name="hostname" required="0" vallist="0" default="" type="string">hostname</param>

11729

11730

<return type="resource">resource</return>

11731

<insert>ldap_connect([string hostname] [,int port]);</insert>

11732

<dialog title="Insert ldap_connect">ldap_connect(%0, %1);</dialog>

11733

11734

</function>

11735

11736

<description>Count the number of entries in a search</description>

11737

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11738

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

11739

11740

<insert>ldap_count_entries(resource link_identifier, resource result_identifier);</insert>

11741

<dialog title="Insert ldap_count_entries">ldap_count_entries(%0, %1);</dialog>

11742

11743

</function>

11744

11745

<description>Delete an entry from a directory</description>

11746

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11747

11748

11749

<insert>ldap_delete(resource link_identifier, string dn);</insert>

11750

<dialog title="Insert ldap_delete">ldap_delete(%0, %1);</dialog>

11751

11752

</function>

11753

11754

<description>Convert DN to User Friendly Naming format</description>

11755

11756

<return type="string">string</return>

11757

<insert>ldap_dn2ufn(string dn);</insert>

11758

11759

11760

</function>

11761

11762

11763

Convert LDAP error number into string error message

11764

</description>

11765

<param name="errno" required="1" vallist="0" default="" type="int">errno</param>

11766

<return type="string">string</return>

11767

<insert>ldap_err2str(int errno);</insert>

11768

11769

11770

</function>

11771

11772

11773

Return the LDAP error number of the last LDAP command

11774

</description>

11775

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11776

11777

<insert>ldap_errno(resource link_identifier);</insert>

11778

<dialog title="Insert ldap_errno">ldap_errno(%0);</dialog>

11779

11780

</function>

11781

11782

11783

Return the LDAP error message of the last LDAP command

11784

</description>

11785

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11786

<return type="string">string</return>

11787

<insert>ldap_error(resource link_identifier);</insert>

11788

<dialog title="Insert ldap_error">ldap_error(%0);</dialog>

11789

11790

</function>

11791

11792

<description>Splits DN into its component parts</description>

11793

11794

<param name="with_attrib" required="1" vallist="0" default="" type="int">with_attrib</param>

11795

<return type="array">array</return>

11796

<insert>ldap_explode_dn(string dn, int with_attrib);</insert>

11797

<dialog title="Insert ldap_explode_dn">ldap_explode_dn(%0, %1);</dialog>

11798

11799

</function>

11800

11801

<description>Return first attribute</description>

11802

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11803

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11804

<param name="ber_identifier" required="1" vallist="0" default="" type="int">ber_identifier</param>

11805

<return type="string">string</return>

11806

<insert>ldap_first_attribute(resource link_identifier, resource result_entry_identifier, int ber_identifier);</insert>

11807

<dialog title="Insert ldap_first_attribute">ldap_first_attribute(%0, %1, %2);</dialog>

11808

11809

</function>

11810

11811

<description>Return first result id</description>

11812

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11813

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

11814

<return type="resource">resource</return>

11815

<insert>ldap_first_entry(resource link_identifier, resource result_identifier);</insert>

11816

<dialog title="Insert ldap_first_entry">ldap_first_entry(%0, %1);</dialog>

11817

11818

</function>

11819

11820

11821

Return first reference

11822

</description>

11823

11824

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

11825

<return type="resource">resource</return>

11826

<insert>ldap_first_reference(resource link, resource result);</insert>

11827

<dialog title="Insert ldap_first_reference">ldap_first_reference(%0, %1);</dialog>

11828

11829

</function>

11830

11831

<description>Free result memory</description>

11832

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

11833

11834

<insert>ldap_free_result(resource result_identifier);</insert>

11835

<dialog title="Insert ldap_free_result">ldap_free_result(%0);</dialog>

11836

11837

</function>

11838

11839

<description>Get attributes from a search result entry</description>

11840

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11841

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11842

<return type="array">array</return>

11843

<insert>ldap_get_attributes(resource link_identifier, resource result_entry_identifier);</insert>

11844

<dialog title="Insert ldap_get_attributes">ldap_get_attributes(%0, %1);</dialog>

11845

11846

</function>

11847

11848

<description>Get the DN of a result entry</description>

11849

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11850

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11851

<return type="string">string</return>

11852

<insert>ldap_get_dn(resource link_identifier, resource result_entry_identifier);</insert>

11853

11854

11855

</function>

11856

11857

<description>Get all result entries</description>

11858

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11859

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

11860

<return type="array">array</return>

11861

<insert>ldap_get_entries(resource link_identifier, resource result_identifier);</insert>

11862

<dialog title="Insert ldap_get_entries">ldap_get_entries(%0, %1);</dialog>

11863

11864

</function>

11865

11866

<description>Get the current value for given option</description>

11867

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11868

<param name="option" required="1" vallist="0" default="" type="int">option</param>

11869

<param name="retval" required="1" vallist="0" default="" type="mixed">retval</param>

11870

11871

<insert>ldap_get_option(resource link_identifier, int option, mixed retval);</insert>

11872

<dialog title="Insert ldap_get_option">ldap_get_option(%0, %1, %2);</dialog>

11873

11874

</function>

11875

11876

<description>Get all binary values from a result entry</description>

11877

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11878

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11879

<param name="attribute" required="1" vallist="0" default="" type="string">attribute</param>

11880

<return type="array">array</return>

11881

<insert>ldap_get_values_len(resource link_identifier, resource result_entry_identifier, string attribute);</insert>

11882

<dialog title="Insert ldap_get_values_len">ldap_get_values_len(%0, %1, %2);</dialog>

11883

11884

</function>

11885

11886

<description>Get all values from a result entry</description>

11887

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11888

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11889

<param name="attribute" required="1" vallist="0" default="" type="string">attribute</param>

11890

<return type="array">array</return>

11891

<insert>ldap_get_values(resource link_identifier, resource result_entry_identifier, string attribute);</insert>

11892

<dialog title="Insert ldap_get_values">ldap_get_values(%0, %1, %2);</dialog>

11893

11894

</function>

11895

11896

<description>Single-level search</description>

11897

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11898

11899

<param name="filter" required="1" vallist="0" default="" type="string">filter</param>

11900

<param name="attributes" required="0" vallist="0" default="" type="array">attributes</param>

11901

<param name="attrsonly" required="0" vallist="0" default="" type="int">attrsonly</param>

11902

<param name="sizelimit" required="0" vallist="0" default="" type="int">sizelimit</param>

11903

<param name="timelimit" required="0" vallist="0" default="" type="int">timelimit</param>

11904

<param name="deref" required="0" vallist="0" default="" type="int">deref</param>

11905

<return type="resource">resource</return>

11906

<insert>ldap_list(resource link_identifier, string base_dn, string filter [,array attributes] [,int attrsonly] [,int sizelimit] [,int timelimit] [,int deref]);</insert>

11907

11908

11909

</function>

11910

11911

<description>Add attribute values to current attributes</description>

11912

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11913

11914

<param name="entry" required="1" vallist="0" default="" type="array">entry</param>

11915

11916

<insert>ldap_mod_add(resource link_identifier, string dn, array entry);</insert>

11917

11918

11919

</function>

11920

11921

<description>Delete attribute values from current attributes</description>

11922

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11923

11924

<param name="entry" required="1" vallist="0" default="" type="array">entry</param>

11925

11926

<insert>ldap_mod_del(resource link_identifier, string dn, array entry);</insert>

11927

11928

11929

</function>

11930

11931

<description>Replace attribute values with new ones</description>

11932

<param name="link_identifier" required="1" vallist="0" default="" type="resoure">link_identifier</param>

11933

11934

<param name="entry" required="1" vallist="0" default="" type="array">entry</param>

11935

11936

<insert>ldap_mod_replace(resoure link_identifier, string dn, array entry);</insert>

11937

<dialog title="Insert ldap_mod_replace">ldap_mod_replace(%0, %1, %2);</dialog>

11938

11939

</function>

11940

11941

<description>Modify an LDAP entry</description>

11942

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11943

11944

<param name="entry" required="1" vallist="0" default="" type="array">entry</param>

11945

11946

<insert>ldap_modify(resource link_identifier, string dn, array entry);</insert>

11947

<dialog title="Insert ldap_modify">ldap_modify(%0, %1, %2);</dialog>

11948

11949

</function>

11950

11951

<description>Get the next attribute in result</description>

11952

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11953

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11954

<param name="ber_identifier" required="1" vallist="0" default="" type="resource">ber_identifier</param>

11955

<return type="string">string</return>

11956

<insert>ldap_next_attribute(resource link_identifier, resource result_entry_identifier, resource ber_identifier);</insert>

11957

<dialog title="Insert ldap_next_attribute">ldap_next_attribute(%0, %1, %2);</dialog>

11958

11959

</function>

11960

11961

<description>Get next result entry</description>

11962

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

11963

<param name="result_entry_identifier" required="1" vallist="0" default="" type="resource">result_entry_identifier</param>

11964

<return type="resource">resource</return>

11965

<insert>ldap_next_entry(resource link_identifier, resource result_entry_identifier);</insert>

11966

<dialog title="Insert ldap_next_entry">ldap_next_entry(%0, %1);</dialog>

11967

11968

</function>

11969

11970

11971

Get next reference

11972

</description>

11973

11974

<param name="entry" required="1" vallist="0" default="" type="resource">entry</param>

11975

<return type="resource">resource</return>

11976

<insert>ldap_next_reference(resource link, resource entry);</insert>

11977

<dialog title="Insert ldap_next_reference">ldap_next_reference(%0, %1);</dialog>

11978

11979

</function>

11980

11981

11982

Extract information from reference entry

11983

</description>

11984

11985

<param name="entry" required="1" vallist="0" default="" type="resource">entry</param>

11986

<param name="referrals" required="1" vallist="0" default="" type="array">referrals</param>

11987

11988

<insert>ldap_parse_reference(resource link, resource entry, array referrals);</insert>

11989

<dialog title="Insert ldap_parse_reference">ldap_parse_reference(%0, %1, %2);</dialog>

11990

11991

</function>

11992

11993

11994

Extract information from result

11995

</description>

11996

11997

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

11998

<param name="errcode" required="1" vallist="0" default="" type="int">errcode</param>

11999

<param name="matcheddn" required="1" vallist="0" default="" type="string">matcheddn</param>

12000

<param name="errmsg" required="1" vallist="0" default="" type="string">errmsg</param>

12001

<param name="referrals" required="1" vallist="0" default="" type="array">referrals</param>

12002

12003

<insert>ldap_parse_result(resource link, resource result, int errcode, string matcheddn, string errmsg, array referrals);</insert>

12004

<dialog title="Insert ldap_parse_result">ldap_parse_result(%0, %1, %2, %3, %4, %5);</dialog>

12005

12006

</function>

12007

12008

<description>Read an entry</description>

12009

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

12010

12011

<param name="filter" required="1" vallist="0" default="" type="string">filter</param>

12012

<param name="attributes" required="0" vallist="0" default="" type="array">attributes</param>

12013

<param name="attrsonly" required="0" vallist="0" default="" type="int">attrsonly</param>

12014

<param name="sizelimit" required="0" vallist="0" default="" type="int">sizelimit</param>

12015

<param name="timelimit" required="0" vallist="0" default="" type="int">timelimit</param>

12016

<param name="deref" required="0" vallist="0" default="" type="int">deref</param>

12017

<return type="resource">resource</return>

12018

<insert>ldap_read(resource link_identifier, string base_dn, string filter [,array attributes] [,int attrsonly] [,int sizelimit] [,int timelimit] [,int deref]);</insert>

12019

12020

12021

</function>

12022

12023

<description>Modify the name of an entry</description>

12024

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

12025

12026

<param name="newrdn" required="1" vallist="0" default="" type="string">newrdn</param>

12027

<param name="newparent" required="1" vallist="0" default="" type="string">newparent</param>

12028

<param name="deleteoldrdn" required="1" vallist="0" default="" type="bool">deleteoldrdn</param>

12029

12030

<insert>ldap_rename(resource link_identifier, string dn, string newrdn, string newparent, bool deleteoldrdn);</insert>

12031

<dialog title="Insert ldap_rename">ldap_rename(%0, %1, %2, %3, %4);</dialog>

12032

12033

</function>

12034

12035

<description>Search LDAP tree</description>

12036

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

12037

12038

<param name="filter" required="1" vallist="0" default="" type="string">filter</param>

12039

<param name="attributes" required="0" vallist="0" default="" type="array">attributes</param>

12040

<param name="attrsonly" required="0" vallist="0" default="" type="int">attrsonly</param>

12041

<param name="sizelimit" required="0" vallist="0" default="" type="int">sizelimit</param>

12042

<param name="timelimit" required="0" vallist="0" default="" type="int">timelimit</param>

12043

<param name="deref" required="0" vallist="0" default="" type="int">deref</param>

12044

<return type="resource">resource</return>

12045

<insert>ldap_search(resource link_identifier, string base_dn, string filter [,array attributes] [,int attrsonly] [,int sizelimit] [,int timelimit] [,int deref]);</insert>

12046

<dialog title="Insert ldap_search">ldap_search(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

12047

12048

</function>

12049

12050

<description>Set the value of the given option</description>

12051

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

12052

<param name="option" required="1" vallist="0" default="" type="int">option</param>

12053

<param name="newval" required="1" vallist="0" default="" type="mixed">newval</param>

12054

12055

<insert>ldap_set_option(resource link_identifier, int option, mixed newval);</insert>

12056

<dialog title="Insert ldap_set_option">ldap_set_option(%0, %1, %2);</dialog>

12057

12058

</function>

12059

12060

12061

Set a callback function to do re-binds on referral chasing.

12062

</description>

12063

12064

<param name="callback" required="1" vallist="0" default="" type="string">callback</param>

12065

12066

<insert>ldap_set_rebind_proc(resource link, string callback);</insert>

12067

<dialog title="Insert ldap_set_rebind_proc">ldap_set_rebind_proc(%0, %1);</dialog>

12068

12069

</function>

12070

12071

12072

Sort LDAP result entries

12073

</description>

12074

12075

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

12076

<param name="sortfilter" required="1" vallist="0" default="" type="string">sortfilter</param>

12077

12078

<insert>ldap_sort(resource link, resource result, string sortfilter);</insert>

12079

12080

12081

</function>

12082

12083

12084

Start TLS

12085

</description>

12086

12087

12088

<insert>ldap_start_tls(resource link);</insert>

12089

<dialog title="Insert ldap_start_tls">ldap_start_tls(%0);</dialog>

12090

12091

</function>

12092

12093

12094

Translate t61 characters to 8859 characters

12095

</description>

12096

<param name="value" required="1" vallist="0" default="" type="string">value</param>

12097

<return type="string">string</return>

12098

<insert>ldap_t61_to_8859(string value);</insert>

12099

12100

12101

</function>

12102

12103

<description>Unbind from LDAP directory</description>

12104

<param name="link_identifier" required="1" vallist="0" default="" type="resource">link_identifier</param>

12105

12106

<insert>ldap_unbind(resource link_identifier);</insert>

12107

<dialog title="Insert ldap_unbind">ldap_unbind(%0);</dialog>

12108

12109

</function>

12110

</group>

12111

12112

12113

<description>Calculate the hash value needed by EZMLM</description>

12114

12115

12116

<insert>ezmlm_hash(string addr);</insert>

12117

<dialog title="Insert ezmlm_hash">ezmlm_hash(%0);</dialog>

12118

12119

</function>

12120

12121

12122

12123

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

12124

<param name="message" required="1" vallist="0" default="" type="string">message</param>

12125

<param name="additional_headers" required="0" vallist="0" default="" type="string">additional_headers</param>

12126

<param name="additional_parameters" required="0" vallist="0" default="" type="string">additional_parameters</param>

12127

12128

<insert>mail(string to, string subject, string message [,string additional_headers] [,string additional_parameters]);</insert>

12129

12130

12131

</function>

12132

</group>

12133

12134

12135

12136

Figures out the best way of encoding the content read from the

12137

file pointer fp, which must be seek-able

12138

</description>

12139

12140

12141

<insert>mailparse_determine_best_xfer_encoding(resource fp);</insert>

12142

<dialog title="Insert mailparse_determine_best_xfer_encoding">mailparse_determine_best_xfer_encoding(%0);</dialog>

12143

12144

</function>

12145

12146

<description>Returns a handle that can be used to parse a message </description>

12147

12148

<insert>mailparse_msg_create();</insert>

12149

<dialog title="Insert mailparse_msg_create">mailparse_msg_create();</dialog>

12150

12151

</function>

12152

12153

<description>Extracts/decodes a message section, decoding the transfer encoding </description>

12154

12155

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

12156

<param name="callbackfunc" required="0" vallist="0" default="" type="string">callbackfunc</param>

12157

<return type="string">string</return>

12158

<insert>mailparse_msg_extract_part_file(resource rfc2045, string filename [,string callbackfunc]);</insert>

12159

<dialog title="Insert mailparse_msg_extract_part_file">mailparse_msg_extract_part_file(%0, %1, %2);</dialog>

12160

12161

</function>

12162

12163

12164

Extracts/decodes a message section. If callbackfunc is not

12165

specified, the contents will be sent to "stdout"

12166

</description>

12167

12168

<param name="msgbody" required="1" vallist="0" default="" type="string">msgbody</param>

12169

<param name="callbackfunc" required="0" vallist="0" default="" type="string">callbackfunc</param>

12170

12171

<insert>mailparse_msg_extract_part(resource rfc2045, string msgbody [,string callbackfunc]);</insert>

12172

<dialog title="Insert mailparse_msg_extract_part">mailparse_msg_extract_part(%0, %1, %2);</dialog>

12173

12174

</function>

12175

12176

<description>Frees a handle allocated by mailparse_msg_crea</description>

12177

12178

12179

<insert>mailparse_msg_free(resource rfc2045buf);</insert>

12180

<dialog title="Insert mailparse_msg_free">mailparse_msg_free(%0);</dialog>

12181

12182

</function>

12183

12184

<description>Returns an associative array of info about the message </description>

12185

12186

<return type="array">array</return>

12187

<insert>mailparse_msg_get_part_data(resource rfc2045);</insert>

12188

<dialog title="Insert mailparse_msg_get_part_data">mailparse_msg_get_part_data(%0);</dialog>

12189

12190

</function>

12191

12192

<description>Returns a handle on a given section in a mimemessage </description>

12193

12194

<param name="mimesection" required="1" vallist="0" default="" type="string">mimesection</param>

12195

12196

<insert>mailparse_msg_get_part(resource rfc2045, string mimesection);</insert>

12197

<dialog title="Insert mailparse_msg_get_part">mailparse_msg_get_part(%0, %1);</dialog>

12198

12199

</function>

12200

12201

<description>Returns an array of mime section names in the supplied message </description>

12202

12203

<return type="array">array</return>

12204

<insert>mailparse_msg_get_structure(resource rfc2045);</insert>

12205

<dialog title="Insert mailparse_msg_get_structure">mailparse_msg_get_structure(%0);</dialog>

12206

12207

</function>

12208

12209

<description>Parse file and return a resource representing the structure </description>

12210

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

12211

<return type="resource">resource</return>

12212

<insert>mailparse_msg_parse_file(string filename);</insert>

12213

<dialog title="Insert mailparse_msg_parse_file">mailparse_msg_parse_file(%0);</dialog>

12214

12215

</function>

12216

12217

<description>Incrementally parse data into buffer </description>

12218

12219

12220

12221

<insert>mailparse_msg_parse(resource rfc2045buf, string data);</insert>

12222

<dialog title="Insert mailparse_msg_parse">mailparse_msg_parse(%0, %1);</dialog>

12223

12224

</function>

12225

12226

12227

Parse addresses and returns a hash containing that data

12228

</description>

12229

<param name="addresses" required="1" vallist="0" default="" type="string">addresses</param>

12230

<return type="array">array</return>

12231

<insert>mailparse_rfc822_parse_addresses(string addresses);</insert>

12232

<dialog title="Insert mailparse_rfc822_parse_addresses">mailparse_rfc822_parse_addresses(%0);</dialog>

12233

12234

</function>

12235

12236

12237

Streams data from source file pointer, apply encoding and write

12238

to destfp

12239

</description>

12240

<param name="sourcefp" required="1" vallist="0" default="" type="resource">sourcefp</param>

12241

<param name="destfp" required="1" vallist="0" default="" type="resource">destfp</param>

12242

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

12243

12244

<insert>mailparse_stream_encode(resource sourcefp, resource destfp, string encoding);</insert>

12245

<dialog title="Insert mailparse_stream_encode">mailparse_stream_encode(%0, %1, %2);</dialog>

12246

12247

</function>

12248

12249

12250

Scans the data from fp and extract each embedded uuencoded

12251

file. Returns an array listing filename information

12252

</description>

12253

12254

<return type="array">array</return>

12255

<insert>mailparse_uudecode_all(resource fp);</insert>

12256

<dialog title="Insert mailparse_uudecode_all">mailparse_uudecode_all(%0);</dialog>

12257

12258

</function>

12259

</group>

12260

12261

12262

<description>Absolute value</description>

12263

<param name="number" required="1" vallist="0" default="" type="mixed">number</param>

12264

<return type="mixed">mixed</return>

12265

<insert>abs(mixed number);</insert>

12266

12267

12268

</function>

12269

12270

<description>Arc cosine</description>

12271

12272

<return type="float">float</return>

12273

<insert>acos(float arg);</insert>

12274

12275

12276

</function>

12277

12278

<description>Inverse hyperbolic cosine</description>

12279

12280

<return type="float">float</return>

12281

<insert>acosh(float arg);</insert>

12282

<dialog title="Insert acosh">acosh(%0);</dialog>

12283

12284

</function>

12285

12286

12287

12288

<return type="float">float</return>

12289

<insert>asin(float arg);</insert>

12290

12291

12292

</function>

12293

12294

<description>Inverse hyperbolic sine</description>

12295

12296

<return type="float">float</return>

12297

<insert>asinh(float arg);</insert>

12298

<dialog title="Insert asinh">asinh(%0);</dialog>

12299

12300

</function>

12301

12302

<description>Arc tangent</description>

12303

12304

<return type="float">float</return>

12305

<insert>atan(float arg);</insert>

12306

12307

12308

</function>

12309

12310

<description>arc tangent of two variables</description>

12311

12312

12313

<return type="float">float</return>

12314

<insert>atan2(float y, float x);</insert>

12315

12316

12317

</function>

12318

12319

<description>Inverse hyperbolic tangent</description>

12320

12321

<return type="float">float</return>

12322

<insert>atanh(float arg);</insert>

12323

<dialog title="Insert atanh">atanh(%0);</dialog>

12324

12325

</function>

12326

12327

<description>Convert a number between arbitrary bases</description>

12328

<param name="number" required="1" vallist="0" default="" type="string">number</param>

12329

<param name="frombase" required="1" vallist="0" default="" type="int">frombase</param>

12330

<param name="tobase" required="1" vallist="0" default="" type="int">tobase</param>

12331

<return type="string">string</return>

12332

<insert>base_convert(string number, int frombase, int tobase);</insert>

12333

<dialog title="Insert base_convert">base_convert(%0, %1, %2);</dialog>

12334

12335

</function>

12336

12337

<description>Binary to decimal</description>

12338

<param name="binary_string" required="1" vallist="0" default="" type="string">binary_string</param>

12339

12340

<insert>bindec(string binary_string);</insert>

12341

<dialog title="Insert bindec">bindec(%0);</dialog>

12342

12343

</function>

12344

12345

<description>Round fractions up</description>

12346

<param name="value" required="1" vallist="0" default="" type="float">value</param>

12347

<return type="float">float</return>

12348

<insert>ceil(float value);</insert>

12349

12350

12351

</function>

12352

12353

<description>Cosine</description>

12354

12355

<return type="float">float</return>

12356

<insert>cos(float arg);</insert>

12357

12358

12359

</function>

12360

12361

<description>Hyperbolic cosine</description>

12362

12363

<return type="float">float</return>

12364

<insert>cosh(float arg);</insert>

12365

12366

12367

</function>

12368

12369

<description>Decimal to binary</description>

12370

<param name="number" required="1" vallist="0" default="" type="int">number</param>

12371

<return type="string">string</return>

12372

<insert>decbin(int number);</insert>

12373

<dialog title="Insert decbin">decbin(%0);</dialog>

12374

12375

</function>

12376

12377

<description>Decimal to hexadecimal</description>

12378

<param name="number" required="1" vallist="0" default="" type="int">number</param>

12379

<return type="string">string</return>

12380

<insert>dechex(int number);</insert>

12381

<dialog title="Insert dechex">dechex(%0);</dialog>

12382

12383

</function>

12384

12385

<description>Decimal to octal</description>

12386

<param name="number" required="1" vallist="0" default="" type="int">number</param>

12387

<return type="string">string</return>

12388

<insert>decoct(int number);</insert>

12389

<dialog title="Insert decoct">decoct(%0);</dialog>

12390

12391

</function>

12392

12393

12394

Converts the number in degrees to the radian equivalent

12395

</description>

12396

<param name="number" required="1" vallist="0" default="" type="float">number</param>

12397

<return type="float">float</return>

12398

<insert>deg2rad(float number);</insert>

12399

12400

12401

</function>

12402

12403

<description>Calculates the exponent of </description>

12404

12405

<return type="float">float</return>

12406

<insert>exp(float arg);</insert>

12407

12408

12409

</function>

12410

12411

12412

Returns exp(number) - 1, computed in a way that is accurate even

12413

when the value of number is close to zero

12414

</description>

12415

<param name="number" required="1" vallist="0" default="" type="float">number</param>

12416

<return type="float">float</return>

12417

<insert>expm1(float number);</insert>

12418

12419

12420

</function>

12421

12422

<description>Round fractions down</description>

12423

<param name="value" required="1" vallist="0" default="" type="float">value</param>

12424

<return type="float">float</return>

12425

<insert>floor(float value);</insert>

12426

<dialog title="Insert floor">floor(%0);</dialog>

12427

12428

</function>

12429

12430

<description>Returns the floating point remainder (modulo) of the division

12431

of the arguments</description>

12432

12433

12434

<return type="float">float</return>

12435

<insert>fmod(float x, float y);</insert>

12436

12437

12438

</function>

12439

12440

<description>Show largest possible random value</description>

12441

12442

<insert>getrandmax();</insert>

12443

<dialog title="Insert getrandmax">getrandmax();</dialog>

12444

12445

</function>

12446

12447

<description>Hexadecimal to decimal</description>

12448

<param name="hex_string" required="1" vallist="0" default="" type="string">hex_string</param>

12449

12450

<insert>hexdec(string hex_string);</insert>

12451

<dialog title="Insert hexdec">hexdec(%0);</dialog>

12452

12453

</function>

12454

12455

12456

Returns sqrt( num1*num1 + num2*num2)

12457

</description>

12458

12459

12460

<return type="float">float</return>

12461

<insert>hypot(float num1, float num2);</insert>

12462

<dialog title="Insert hypot">hypot(%0, %1);</dialog>

12463

12464

</function>

12465

12466

12467

</description>

12468

12469

12470

<insert>is_finite(float val);</insert>

12471

<dialog title="Insert is_finite">is_finite(%0);</dialog>

12472

12473

</function>

12474

12475

12476

</description>

12477

12478

12479

<insert>is_infinite(float val);</insert>

12480

<dialog title="Insert is_infinite">is_infinite(%0);</dialog>

12481

12482

</function>

12483

12484

12485

</description>

12486

12487

12488

<insert>is_nan(float val);</insert>

12489

12490

12491

</function>

12492

12493

<description>Combined linear congruential generator</description>

12494

<return type="float">float</return>

12495

<insert>lcg_value();</insert>

12496

<dialog title="Insert lcg_value">lcg_value();</dialog>

12497

12498

</function>

12499

12500

<description>Natural logarithm</description>

12501

12502

12503

<return type="float">float</return>

12504

<insert>log(float arg [,float base]);</insert>

12505

12506

12507

</function>

12508

12509

<description>Base-10 logarithm</description>

12510

12511

<return type="float">float</return>

12512

<insert>log10(float arg);</insert>

12513

12514

12515

</function>

12516

12517

12518

Returns log(1 + number), computed in a way that accurate even when the val

12519

ue of number is close to zero

12520

</description>

12521

<param name="number" required="1" vallist="0" default="" type="float">number</param>

12522

<return type="float">float</return>

12523

<insert>log1p(float number);</insert>

12524

12525

12526

</function>

12527

12528

<description>Find highest value</description>

12529

12530

12531

12532

<return type="number">number</return>

12533

<insert>max(mixed arg1, mixed arg2, mixed argn);</insert>

12534

12535

12536

</function>

12537

12538

<description>Find lowest value</description>

12539

12540

12541

<return type="number">number</return>

12542

<insert>min(number arg1, number arg2);</insert>

12543

12544

12545

</function>

12546

12547

<description>Show largest possible random value</description>

12548

12549

<insert>mt_getrandmax();</insert>

12550

<dialog title="Insert mt_getrandmax">mt_getrandmax();</dialog>

12551

12552

</function>

12553

12554

<description>Generate a better random value</description>

12555

12556

12557

12558

12559

12560

12561

</function>

12562

12563

<description>Seed the better random number generator</description>

12564

12565

12566

<insert>mt_srand(int seed);</insert>

12567

<dialog title="Insert mt_srand">mt_srand(%0);</dialog>

12568

12569

</function>

12570

12571

<description>Octal to decimal</description>

12572

<param name="octal_string" required="1" vallist="0" default="" type="string">octal_string</param>

12573

12574

<insert>octdec(string octal_string);</insert>

12575

<dialog title="Insert octdec">octdec(%0);</dialog>

12576

12577

</function>

12578

12579

<description>Get value of pi</description>

12580

<return type="float">float</return>

12581

12582

12583

12584

</function>

12585

12586

<description>Exponential expression</description>

12587

12588

12589

<return type="number">number</return>

12590

<insert>pow(number base, number exp);</insert>

12591

12592

12593

</function>

12594

12595

12596

Converts the radian number to the equivalent number in degrees

12597

</description>

12598

<param name="number" required="1" vallist="0" default="" type="float">number</param>

12599

<return type="float">float</return>

12600

<insert>rad2deg(float number);</insert>

12601

12602

12603

</function>

12604

12605

<description>Generate a random value</description>

12606

12607

12608

12609

12610

12611

12612

</function>

12613

12614

<description>Rounds a float</description>

12615

12616

<param name="precision" required="0" vallist="0" default="" type="int">precision</param>

12617

<return type="float">float</return>

12618

<insert>round(float val [,int precision]);</insert>

12619

<dialog title="Insert round">round(%0, %1);</dialog>

12620

12621

</function>

12622

12623

12624

12625

<return type="float">float</return>

12626

<insert>sin(float arg);</insert>

12627

12628

12629

</function>

12630

12631

<description>Hyperbolic sine</description>

12632

12633

<return type="float">float</return>

12634

<insert>sinh(float arg);</insert>

12635

12636

12637

</function>

12638

12639

<description>Square root</description>

12640

12641

<return type="float">float</return>

12642

<insert>sqrt(float arg);</insert>

12643

12644

12645

</function>

12646

12647

<description>Seed the random number generator</description>

12648

12649

12650

<insert>srand(int seed);</insert>

12651

<dialog title="Insert srand">srand(%0);</dialog>

12652

12653

</function>

12654

12655

<description>Tangent</description>

12656

12657

<return type="float">float</return>

12658

<insert>tan(float arg);</insert>

12659

12660

12661

</function>

12662

12663

<description>Hyperbolic tangent</description>

12664

12665

<return type="float">float</return>

12666

<insert>tanh(float arg);</insert>

12667

12668

12669

</function>

12670

</group>

12671

12672

12673

<description>Perform case folding on a string</description>

12674

12675

12676

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12677

<return type="string">string</return>

12678

<insert>mb_convert_case(string str, int mode [,string encoding]);</insert>

12679

<dialog title="Insert mb_convert_case">mb_convert_case(%0, %1, %2);</dialog>

12680

12681

</function>

12682

12683

<description>Convert character encoding</description>

12684

12685

<param name="to-encoding" required="1" vallist="0" default="" type="string">to-encoding</param>

12686

<param name="from-encoding" required="0" vallist="0" default="" type="mixed">from-encoding</param>

12687

<return type="string">string</return>

12688

<insert>mb_convert_encoding(string str, string to-encoding [,mixed from-encoding]);</insert>

12689

<dialog title="Insert mb_convert_encoding">mb_convert_encoding(%0, %1, %2);</dialog>

12690

12691

</function>

12692

12693

12694

Convert "kana" one from another ("zen-kaku" ,"han-kaku" and more)

12695

</description>

12696

12697

<param name="option" required="1" vallist="0" default="" type="string">option</param>

12698

<param name="encoding" required="0" vallist="0" default="" type="mixed">encoding</param>

12699

<return type="string">string</return>

12700

<insert>mb_convert_kana(string str, string option [,mixed encoding]);</insert>

12701

<dialog title="Insert mb_convert_kana">mb_convert_kana(%0, %1, %2);</dialog>

12702

12703

</function>

12704

12705

<description>Convert character code in variable(s)</description>

12706

<param name="to-encoding" required="1" vallist="0" default="" type="string">to-encoding</param>

12707

<param name="from-encoding" required="1" vallist="0" default="" type="mixed">from-encoding</param>

12708

12709

<return type="string">string</return>

12710

<insert>mb_convert_variables(string to-encoding, mixed from-encoding, mixed vars);</insert>

12711

<dialog title="Insert mb_convert_variables">mb_convert_variables(%0, %1, %2);</dialog>

12712

12713

</function>

12714

12715

<description>Decode string in MIME header field</description>

12716

12717

<return type="string">string</return>

12718

<insert>mb_decode_mimeheader(string str);</insert>

12719

<dialog title="Insert mb_decode_mimeheader">mb_decode_mimeheader(%0);</dialog>

12720

12721

</function>

12722

12723

12724

Decode HTML numeric string reference to character

12725

</description>

12726

12727

<param name="convmap" required="1" vallist="0" default="" type="array">convmap</param>

12728

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12729

<return type="string">string</return>

12730

<insert>mb_decode_numericentity(string str, array convmap [,string encoding]);</insert>

12731

<dialog title="Insert mb_decode_numericentity">mb_decode_numericentity(%0, %1, %2);</dialog>

12732

12733

</function>

12734

12735

<description>Detect character encoding</description>

12736

12737

<param name="encoding-list" required="0" vallist="0" default="" type="mixed">encoding-list</param>

12738

<return type="string">string</return>

12739

<insert>mb_detect_encoding(string str [,mixed encoding-list]);</insert>

12740

<dialog title="Insert mb_detect_encoding">mb_detect_encoding(%0, %1);</dialog>

12741

12742

</function>

12743

12744

12745

Set/Get character encoding detection order

12746

</description>

12747

<param name="encoding-list" required="0" vallist="0" default="" type="mixed">encoding-list</param>

12748

<return type="array">array</return>

12749

<insert>mb_detect_order([mixed encoding-list]);</insert>

12750

<dialog title="Insert mb_detect_order">mb_detect_order(%0);</dialog>

12751

12752

</function>

12753

12754

<description>Encode string for MIME header</description>

12755

12756

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

12757

<param name="transfer-encoding" required="0" vallist="0" default="" type="string">transfer-encoding</param>

12758

<param name="linefeed" required="0" vallist="0" default="" type="string">linefeed</param>

12759

<return type="string">string</return>

12760

<insert>mb_encode_mimeheader(string str [,string charset] [,string transfer-encoding] [,string linefeed]);</insert>

12761

<dialog title="Insert mb_encode_mimeheader">mb_encode_mimeheader(%0, %1, %2, %3);</dialog>

12762

12763

</function>

12764

12765

12766

Encode character to HTML numeric string reference

12767

</description>

12768

12769

<param name="convmap" required="1" vallist="0" default="" type="array">convmap</param>

12770

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12771

<return type="string">string</return>

12772

<insert>mb_encode_numericentity(string str, array convmap [,string encoding]);</insert>

12773

<dialog title="Insert mb_encode_numericentity">mb_encode_numericentity(%0, %1, %2);</dialog>

12774

12775

</function>

12776

12777

12778

Regular expression match for multibyte string

12779

</description>

12780

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

12781

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12782

<param name="option" required="0" vallist="0" default="" type="string">option</param>

12783

12784

<insert>mb_ereg_match(string pattern, string string [,string option]);</insert>

12785

<dialog title="Insert mb_ereg_match">mb_ereg_match(%0, %1, %2);</dialog>

12786

12787

</function>

12788

12789

<description>Replace regular expression with multibyte support</description>

12790

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

12791

<param name="replacement" required="1" vallist="0" default="" type="string">replacement</param>

12792

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12793

<param name="option" required="0" vallist="0" default="" type="array">option</param>

12794

<return type="string">string</return>

12795

<insert>mb_ereg_replace(string pattern, string replacement, string string [,array option]);</insert>

12796

<dialog title="Insert mb_ereg_replace">mb_ereg_replace(%0, %1, %2, %3);</dialog>

12797

12798

</function>

12799

12800

12801

Returns start point for next regular expression match

12802

</description>

12803

<return type="array">array</return>

12804

<insert>mb_ereg_search_getpos();</insert>

12805

<dialog title="Insert mb_ereg_search_getpos">mb_ereg_search_getpos();</dialog>

12806

12807

</function>

12808

12809

12810

Retrive the result from the last multibyte regular expression

12811

match

12812

</description>

12813

<return type="array">array</return>

12814

<insert>mb_ereg_search_getregs();</insert>

12815

<dialog title="Insert mb_ereg_search_getregs">mb_ereg_search_getregs();</dialog>

12816

12817

</function>

12818

12819

12820

Setup string and regular expression for multibyte regular

12821

expression match

12822

</description>

12823

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12824

<param name="pattern" required="0" vallist="0" default="" type="string">pattern</param>

12825

<param name="option" required="0" vallist="0" default="" type="string">option</param>

12826

<return type="array">array</return>

12827

<insert>mb_ereg_search_init(string string [,string pattern] [,string option]);</insert>

12828

<dialog title="Insert mb_ereg_search_init">mb_ereg_search_init(%0, %1, %2);</dialog>

12829

12830

</function>

12831

12832

12833

Return position and length of matched part of multibyte regular

12834

expression for predefined multibyte string

12835

</description>

12836

<param name="pattern" required="0" vallist="0" default="" type="string">pattern</param>

12837

<param name="option" required="0" vallist="0" default="" type="string">option</param>

12838

<return type="array">array</return>

12839

<insert>mb_ereg_search_pos([string pattern] [,string option]);</insert>

12840

<dialog title="Insert mb_ereg_search_pos">mb_ereg_search_pos(%0, %1);</dialog>

12841

12842

</function>

12843

12844

12845

Returns the matched part of multibyte regular expression

12846

</description>

12847

<param name="pattern" required="0" vallist="0" default="" type="string">pattern</param>

12848

<param name="option" required="0" vallist="0" default="" type="string">option</param>

12849

<return type="array">array</return>

12850

<insert>mb_ereg_search_regs([string pattern] [,string option]);</insert>

12851

<dialog title="Insert mb_ereg_search_regs">mb_ereg_search_regs(%0, %1);</dialog>

12852

12853

</function>

12854

12855

12856

Set start point of next regular expression match

12857

</description>

12858

<return type="array">array</return>

12859

<insert>mb_ereg_search_setpos();</insert>

12860

<dialog title="Insert mb_ereg_search_setpos">mb_ereg_search_setpos();</dialog>

12861

12862

</function>

12863

12864

12865

Multibyte regular expression match for predefined multibyte string

12866

</description>

12867

<param name="pattern" required="0" vallist="0" default="" type="string">pattern</param>

12868

<param name="option" required="0" vallist="0" default="" type="string">option</param>

12869

12870

<insert>mb_ereg_search([string pattern] [,string option]);</insert>

12871

<dialog title="Insert mb_ereg_search">mb_ereg_search(%0, %1);</dialog>

12872

12873

</function>

12874

12875

<description>Regular expression match with multibyte support</description>

12876

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

12877

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12878

12879

12880

<insert>mb_ereg(string pattern, string string [,array regs]);</insert>

12881

12882

12883

</function>

12884

12885

12886

Replace regular expression with multibyte support

12887

ignoring case

12888

</description>

12889

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

12890

<param name="replace" required="1" vallist="0" default="" type="string">replace</param>

12891

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12892

<return type="string">string</return>

12893

<insert>mb_eregi_replace(string pattern, string replace, string string);</insert>

12894

<dialog title="Insert mb_eregi_replace">mb_eregi_replace(%0, %1, %2);</dialog>

12895

12896

</function>

12897

12898

12899

Regular expression match ignoring case with multibyte support

12900

</description>

12901

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

12902

<param name="string" required="1" vallist="0" default="" type="string">string</param>

12903

12904

12905

<insert>mb_eregi(string pattern, string string [,array regs]);</insert>

12906

<dialog title="Insert mb_eregi">mb_eregi(%0, %1, %2);</dialog>

12907

12908

</function>

12909

12910

<description>Get internal settings of mbstring</description>

12911

12912

<return type="string">string</return>

12913

<insert>mb_get_info([string type]);</insert>

12914

12915

12916

</function>

12917

12918

<description>Detect HTTP input character encoding</description>

12919

12920

<return type="string">string</return>

12921

<insert>mb_http_input([string type]);</insert>

12922

<dialog title="Insert mb_http_input">mb_http_input(%0);</dialog>

12923

12924

</function>

12925

12926

<description>Set/Get HTTP output character encoding</description>

12927

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12928

<return type="string">string</return>

12929

<insert>mb_http_output([string encoding]);</insert>

12930

<dialog title="Insert mb_http_output">mb_http_output(%0);</dialog>

12931

12932

</function>

12933

12934

12935

Set/Get internal character encoding

12936

</description>

12937

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12938

<return type="string">string</return>

12939

<insert>mb_internal_encoding([string encoding]);</insert>

12940

<dialog title="Insert mb_internal_encoding">mb_internal_encoding(%0);</dialog>

12941

12942

</function>

12943

12944

12945

Set/Get current language

12946

</description>

12947

<param name="language" required="0" vallist="0" default="" type="string">language</param>

12948

<return type="string">string</return>

12949

<insert>mb_language([string language]);</insert>

12950

<dialog title="Insert mb_language">mb_language(%0);</dialog>

12951

12952

</function>

12953

12954

12955

Callback function converts character encoding in output buffer

12956

</description>

12957

<param name="contents" required="1" vallist="0" default="" type="string">contents</param>

12958

<param name="status" required="1" vallist="0" default="" type="int">status</param>

12959

<return type="string">string</return>

12960

<insert>mb_output_handler(string contents, int status);</insert>

12961

<dialog title="Insert mb_output_handler">mb_output_handler(%0, %1);</dialog>

12962

12963

</function>

12964

12965

12966

Parse GET/POST/COOKIE data and set global variable

12967

</description>

12968

<param name="encoded_string" required="1" vallist="0" default="" type="string">encoded_string</param>

12969

<param name="result" required="0" vallist="0" default="" type="array">result</param>

12970

12971

<insert>mb_parse_str(string encoded_string [,array result]);</insert>

12972

<dialog title="Insert mb_parse_str">mb_parse_str(%0, %1);</dialog>

12973

12974

</function>

12975

12976

<description>Get MIME charset string</description>

12977

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

12978

<return type="string">string</return>

12979

<insert>mb_preferred_mime_name(string encoding);</insert>

12980

<dialog title="Insert mb_preferred_mime_name">mb_preferred_mime_name(%0);</dialog>

12981

12982

</function>

12983

12984

12985

Returns current encoding for multibyte regex as string

12986

</description>

12987

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

12988

<return type="string">string</return>

12989

<insert>mb_regex_encoding([string encoding]);</insert>

12990

<dialog title="Insert mb_regex_encoding">mb_regex_encoding(%0);</dialog>

12991

12992

</function>

12993

12994

12995

Set/Get the default options for mbregex functions

12996

</description>

12997

<param name="options" required="0" vallist="0" default="" type="string">options</param>

12998

<return type="string">string</return>

12999

<insert>mb_regex_set_options([string options]);</insert>

13000

<dialog title="Insert mb_regex_set_options">mb_regex_set_options(%0);</dialog>

13001

13002

</function>

13003

13004

13005

Send encoded mail.

13006

</description>

13007

13008

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

13009

<param name="message" required="1" vallist="0" default="" type="string">message</param>

13010

<param name="additional_headers" required="0" vallist="0" default="" type="string">additional_headers</param>

13011

<param name="additional_parameter" required="0" vallist="0" default="" type="string">additional_parameter</param>

13012

13013

<insert>mb_send_mail(string to, string subject, string message [,string additional_headers] [,string additional_parameter]);</insert>

13014

13015

13016

</function>

13017

13018

<description>Split multibyte string using regular expression</description>

13019

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

13020

<param name="string" required="1" vallist="0" default="" type="string">string</param>

13021

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

13022

<return type="array">array</return>

13023

<insert>mb_split(string pattern, string string [,int limit]);</insert>

13024

<dialog title="Insert mb_split">mb_split(%0, %1, %2);</dialog>

13025

13026

</function>

13027

13028

<description>Get part of string</description>

13029

13030

<param name="start" required="1" vallist="0" default="" type="int">start</param>

13031

<param name="length" required="0" vallist="0" default="" type="int">length</param>

13032

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13033

<return type="string">string</return>

13034

<insert>mb_strcut(string str, int start [,int length] [,string encoding]);</insert>

13035

<dialog title="Insert mb_strcut">mb_strcut(%0, %1, %2, %3);</dialog>

13036

13037

</function>

13038

13039

<description>Get truncated string with specified width</description>

13040

13041

<param name="start" required="1" vallist="0" default="" type="int">start</param>

13042

<param name="width" required="1" vallist="0" default="" type="int">width</param>

13043

<param name="trimmarker" required="1" vallist="0" default="" type="string">trimmarker</param>

13044

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13045

<return type="string">string</return>

13046

<insert>mb_strimwidth(string str, int start, int width, string trimmarker [,string encoding]);</insert>

13047

<dialog title="Insert mb_strimwidth">mb_strimwidth(%0, %1, %2, %3, %4);</dialog>

13048

13049

</function>

13050

13051

<description>Get string length</description>

13052

13053

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13054

<return type="string">string</return>

13055

<insert>mb_strlen(string str [,string encoding]);</insert>

13056

<dialog title="Insert mb_strlen">mb_strlen(%0, %1);</dialog>

13057

13058

</function>

13059

13060

13061

Find position of first occurrence of string in a string

13062

</description>

13063

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

13064

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

13065

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

13066

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13067

13068

<insert>mb_strpos(string haystack, string needle [,int offset] [,string encoding]);</insert>

13069

<dialog title="Insert mb_strpos">mb_strpos(%0, %1, %2, %3);</dialog>

13070

13071

</function>

13072

13073

13074

Find position of last occurrence of a string in a string

13075

</description>

13076

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

13077

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

13078

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13079

13080

<insert>mb_strrpos(string haystack, string needle [,string encoding]);</insert>

13081

<dialog title="Insert mb_strrpos">mb_strrpos(%0, %1, %2);</dialog>

13082

13083

</function>

13084

13085

<description>Make a string lowercase</description>

13086

13087

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13088

<return type="string">string</return>

13089

<insert>mb_strtolower(string str [,string encoding]);</insert>

13090

<dialog title="Insert mb_strtolower">mb_strtolower(%0, %1);</dialog>

13091

13092

</function>

13093

13094

<description>Make a string uppercase</description>

13095

13096

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13097

<return type="string">string</return>

13098

<insert>mb_strtoupper(string str [,string encoding]);</insert>

13099

<dialog title="Insert mb_strtoupper">mb_strtoupper(%0, %1);</dialog>

13100

13101

</function>

13102

13103

<description>Return width of string</description>

13104

13105

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13106

13107

<insert>mb_strwidth(string str [,string encoding]);</insert>

13108

<dialog title="Insert mb_strwidth">mb_strwidth(%0, %1);</dialog>

13109

13110

</function>

13111

13112

<description>Set/Get substitution character</description>

13113

<param name="substrchar" required="0" vallist="0" default="" type="mixed">substrchar</param>

13114

<return type="mixed">mixed</return>

13115

<insert>mb_substitute_character([mixed substrchar]);</insert>

13116

<dialog title="Insert mb_substitute_character">mb_substitute_character(%0);</dialog>

13117

13118

</function>

13119

13120

<description>Count the number of substring occurrences</description>

13121

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

13122

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

13123

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13124

13125

<insert>mb_substr_count(string haystack, string needle [,string encoding]);</insert>

13126

<dialog title="Insert mb_substr_count">mb_substr_count(%0, %1, %2);</dialog>

13127

13128

</function>

13129

13130

<description>Get part of string</description>

13131

13132

<param name="start" required="1" vallist="0" default="" type="int">start</param>

13133

<param name="length" required="0" vallist="0" default="" type="int">length</param>

13134

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

13135

<return type="string">string</return>

13136

<insert>mb_substr(string str, int start [,int length] [,string encoding]);</insert>

13137

<dialog title="Insert mb_substr">mb_substr(%0, %1, %2, %3);</dialog>

13138

13139

</function>

13140

</group>

13141

13142

13143

<description>Store a new event into an MCAL calendar</description>

13144

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13145

13146

<insert>mcal_append_event(int mcal_stream);</insert>

13147

<dialog title="Insert mcal_append_event">mcal_append_event(%0);</dialog>

13148

13149

</function>

13150

13151

<description>Close an MCAL stream</description>

13152

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13153

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

13154

13155

<insert>mcal_close(int mcal_stream, int flags);</insert>

13156

<dialog title="Insert mcal_close">mcal_close(%0, %1);</dialog>

13157

13158

</function>

13159

13160

<description>Create a new MCAL calendar </description>

13161

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13162

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

13163

<return type="string">string</return>

13164

<insert>mcal_create_calendar(int stream, string calendar);</insert>

13165

<dialog title="Insert mcal_create_calendar">mcal_create_calendar(%0, %1);</dialog>

13166

13167

</function>

13168

13169

<description>Compares two dates</description>

13170

13171

<param name="a_month" required="1" vallist="0" default="" type="int">a_month</param>

13172

13173

13174

<param name="b_month" required="1" vallist="0" default="" type="int">b_month</param>

13175

13176

13177

<insert>mcal_date_compare(int a_year, int a_month, int a_day, int b_year, int b_month, int b_day);</insert>

13178

<dialog title="Insert mcal_date_compare">mcal_date_compare(%0, %1, %2, %3, %4, %5);</dialog>

13179

13180

</function>

13181

13182

13183

Returns </description>

13184

13185

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13186

13187

13188

<insert>mcal_date_valid(int year, int month, int day);</insert>

13189

<dialog title="Insert mcal_date_valid">mcal_date_valid(%0, %1, %2);</dialog>

13190

13191

</function>

13192

13193

13194

Returns the day of the week of the given date

13195

</description>

13196

13197

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13198

13199

13200

<insert>mcal_day_of_week(int year, int month, int day);</insert>

13201

13202

13203

</function>

13204

13205

13206

Returns the day of the year of the given date

13207

</description>

13208

13209

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13210

13211

13212

<insert>mcal_day_of_year(int year, int month, int day);</insert>

13213

13214

13215

</function>

13216

13217

13218

Returns the number of days in a month

13219

</description>

13220

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13221

13222

13223

<insert>mcal_days_in_month(int month, int leap_year);</insert>

13224

<dialog title="Insert mcal_days_in_month">mcal_days_in_month(%0, %1);</dialog>

13225

13226

</function>

13227

13228

<description>Delete an MCAL calendar</description>

13229

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13230

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

13231

<return type="string">string</return>

13232

<insert>mcal_delete_calendar(int stream, string calendar);</insert>

13233

<dialog title="Insert mcal_delete_calendar">mcal_delete_calendar(%0, %1);</dialog>

13234

13235

</function>

13236

13237

<description>Delete an event from an MCAL calendar</description>

13238

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13239

<param name="event_id" required="0" vallist="0" default="" type="int">event_id</param>

13240

13241

<insert>mcal_delete_event(int mcal_stream [,int event_id]);</insert>

13242

<dialog title="Insert mcal_delete_event">mcal_delete_event(%0, %1);</dialog>

13243

13244

</function>

13245

13246

13247

Adds an attribute and a value to the streams global event structure

13248

</description>

13249

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13250

<param name="attribute" required="1" vallist="0" default="" type="string">attribute</param>

13251

<param name="value" required="1" vallist="0" default="" type="string">value</param>

13252

13253

<insert>mcal_event_add_attribute(int stream, string attribute, string value);</insert>

13254

<dialog title="Insert mcal_event_add_attribute">mcal_event_add_attribute(%0, %1, %2);</dialog>

13255

13256

</function>

13257

13258

13259

Initializes a streams global event structure

13260

</description>

13261

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13262

13263

<insert>mcal_event_init(int stream);</insert>

13264

<dialog title="Insert mcal_event_init">mcal_event_init(%0);</dialog>

13265

13266

</function>

13267

13268

13269

Sets the alarm of the streams global event structure

13270

</description>

13271

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13272

<param name="alarm" required="1" vallist="0" default="" type="int">alarm</param>

13273

13274

<insert>mcal_event_set_alarm(int stream, int alarm);</insert>

13275

<dialog title="Insert mcal_event_set_alarm">mcal_event_set_alarm(%0, %1);</dialog>

13276

13277

</function>

13278

13279

13280

Sets the category of the streams global event structure

13281

</description>

13282

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13283

<param name="category" required="1" vallist="0" default="" type="string">category</param>

13284

13285

<insert>mcal_event_set_category(int stream, string category);</insert>

13286

<dialog title="Insert mcal_event_set_category">mcal_event_set_category(%0, %1);</dialog>

13287

13288

</function>

13289

13290

13291

Sets the class of the streams global event structure

13292

</description>

13293

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13294

<param name="class" required="1" vallist="0" default="" type="int">class</param>

13295

13296

<insert>mcal_event_set_class(int stream, int class);</insert>

13297

<dialog title="Insert mcal_event_set_class">mcal_event_set_class(%0, %1);</dialog>

13298

13299

</function>

13300

13301

13302

Sets the description of the streams global event structure

13303

</description>

13304

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13305

<param name="description" required="1" vallist="0" default="" type="string">description</param>

13306

13307

<insert>mcal_event_set_description(int stream, string description);</insert>

13308

<dialog title="Insert mcal_event_set_description">mcal_event_set_description(%0, %1);</dialog>

13309

13310

</function>

13311

13312

13313

Sets the end date and time of the streams global event structure

13314

</description>

13315

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13316

13317

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13318

<param name="

13319

day

13320

" required="0" vallist="0" default="" type="int">

13321

day

13322

</param>

13323

<param name="

13324

hour

13325

" required="0" vallist="0" default="" type="int">

13326

hour

13327

</param>

13328

<param name="

13329

min

13330

" required="0" vallist="0" default="" type="int">

13331

min

13332

</param>

13333

<param name="

13334

sec

13335

" required="0" vallist="0" default="" type="int">

13336

sec

13337

</param>

13338

13339

<insert>mcal_event_set_end(int stream, int year, int month [,int

13340

day

13341

] [,int

13342

hour

13343

] [,int

13344

min

13345

] [,int

13346

sec

13347

]);</insert>

13348

<dialog title="Insert mcal_event_set_end">mcal_event_set_end(%0, %1, %2, %3, %4, %5, %6);</dialog>

13349

13350

</function>

13351

13352

13353

Sets the recurrence of the streams global event structure

13354

</description>

13355

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13356

13357

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13358

13359

<param name="interval" required="1" vallist="0" default="" type="int">interval</param>

13360

13361

<insert>mcal_event_set_recur_daily(int stream, int year, int month, int day, int interval);</insert>

13362

<dialog title="Insert mcal_event_set_recur_daily">mcal_event_set_recur_daily(%0, %1, %2, %3, %4);</dialog>

13363

13364

</function>

13365

13366

13367

Sets the recurrence of the streams global event structure

13368

</description>

13369

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13370

13371

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13372

13373

<param name="interval" required="1" vallist="0" default="" type="int">interval</param>

13374

13375

<insert>mcal_event_set_recur_monthly_mday(int stream, int year, int month, int day, int interval);</insert>

13376

<dialog title="Insert mcal_event_set_recur_monthly_mday">mcal_event_set_recur_monthly_mday(%0, %1, %2, %3, %4);</dialog>

13377

13378

</function>

13379

13380

13381

Sets the recurrence of the streams global event structure

13382

</description>

13383

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13384

13385

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13386

13387

<param name="interval" required="1" vallist="0" default="" type="int">interval</param>

13388

13389

<insert>mcal_event_set_recur_monthly_wday(int stream, int year, int month, int day, int interval);</insert>

13390

<dialog title="Insert mcal_event_set_recur_monthly_wday">mcal_event_set_recur_monthly_wday(%0, %1, %2, %3, %4);</dialog>

13391

13392

</function>

13393

13394

13395

Sets the recurrence of the streams global event structure

13396

</description>

13397

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13398

13399

<insert>mcal_event_set_recur_none(int stream);</insert>

13400

<dialog title="Insert mcal_event_set_recur_none">mcal_event_set_recur_none(%0);</dialog>

13401

13402

</function>

13403

13404

13405

Sets the recurrence of the streams global event structure

13406

</description>

13407

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13408

13409

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13410

13411

<param name="interval" required="1" vallist="0" default="" type="int">interval</param>

13412

<param name="weekdays" required="1" vallist="0" default="" type="int">weekdays</param>

13413

13414

<insert>mcal_event_set_recur_weekly(int stream, int year, int month, int day, int interval, int weekdays);</insert>

13415

<dialog title="Insert mcal_event_set_recur_weekly">mcal_event_set_recur_weekly(%0, %1, %2, %3, %4, %5);</dialog>

13416

13417

</function>

13418

13419

13420

Sets the recurrence of the streams global event structure

13421

</description>

13422

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13423

13424

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13425

13426

<param name="interval" required="1" vallist="0" default="" type="int">interval</param>

13427

13428

<insert>mcal_event_set_recur_yearly(int stream, int year, int month, int day, int interval);</insert>

13429

<dialog title="Insert mcal_event_set_recur_yearly">mcal_event_set_recur_yearly(%0, %1, %2, %3, %4);</dialog>

13430

13431

</function>

13432

13433

13434

Sets the start date and time of the streams global event

13435

structure

13436

</description>

13437

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13438

13439

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13440

<param name="

13441

day

13442

" required="0" vallist="0" default="" type="int">

13443

day

13444

</param>

13445

<param name="

13446

hour

13447

" required="0" vallist="0" default="" type="int">

13448

hour

13449

</param>

13450

<param name="

13451

min" required="0" vallist="0" default="" type="int">

13452

min</param>

13453

<param name="

13454

sec

13455

" required="0" vallist="0" default="" type="int">

13456

sec

13457

</param>

13458

13459

<insert>mcal_event_set_start(int stream, int year, int month [,int

13460

day

13461

] [,int

13462

hour

13463

] [,int

13464

min] [,int

13465

sec

13466

]);</insert>

13467

<dialog title="Insert mcal_event_set_start">mcal_event_set_start(%0, %1, %2, %3, %4, %5, %6);</dialog>

13468

13469

</function>

13470

13471

13472

Sets the title of the streams global event structure

13473

</description>

13474

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13475

<param name="title" required="1" vallist="0" default="" type="string">title</param>

13476

13477

<insert>mcal_event_set_title(int stream, string title);</insert>

13478

<dialog title="Insert mcal_event_set_title">mcal_event_set_title(%0, %1);</dialog>

13479

13480

</function>

13481

13482

13483

Deletes all events marked for being expunged.

13484

</description>

13485

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13486

13487

<insert>mcal_expunge(int stream);</insert>

13488

<dialog title="Insert mcal_expunge">mcal_expunge(%0);</dialog>

13489

13490

</function>

13491

13492

13493

Returns an object containing the current streams event structure

13494

</description>

13495

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13496

<return type="object">object</return>

13497

<insert>mcal_fetch_current_stream_event(int stream);</insert>

13498

<dialog title="Insert mcal_fetch_current_stream_event">mcal_fetch_current_stream_event(%0);</dialog>

13499

13500

</function>

13501

13502

13503

Fetches an event from the calendar stream

13504

</description>

13505

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13506

<param name="event_id" required="1" vallist="0" default="" type="int">event_id</param>

13507

<param name="options" required="0" vallist="0" default="" type="int">options</param>

13508

<return type="object">object</return>

13509

<insert>mcal_fetch_event(int mcal_stream, int event_id [,int options]);</insert>

13510

<dialog title="Insert mcal_fetch_event">mcal_fetch_event(%0, %1, %2);</dialog>

13511

13512

</function>

13513

13514

13515

Returns if the given year is a leap year or not

13516

</description>

13517

13518

13519

13520

13521

13522

</function>

13523

13524

13525

Return a list of events that has an alarm triggered at the given

13526

datetime

13527

</description>

13528

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13529

<param name="begin_year" required="0" vallist="0" default="" type="int">begin_year</param>

13530

<param name="begin_month" required="0" vallist="0" default="" type="int">begin_month</param>

13531

<param name="begin_day" required="0" vallist="0" default="" type="int">begin_day</param>

13532

13533

<param name="end_month" required="0" vallist="0" default="" type="int">end_month</param>

13534

13535

<return type="array">array</return>

13536

<insert>mcal_list_alarms(int mcal_stream [,int begin_year] [,int begin_month] [,int begin_day] [,int end_year] [,int end_month] [,int end_day]);</insert>

13537

<dialog title="Insert mcal_list_alarms">mcal_list_alarms(%0, %1, %2, %3, %4, %5, %6);</dialog>

13538

13539

</function>

13540

13541

13542

Return a list of IDs for a date or a range of dates

13543

</description>

13544

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13545

<param name="begin_date" required="1" vallist="0" default="" type="object">begin_date</param>

13546

13547

<return type="array">array</return>

13548

<insert>mcal_list_events(int mcal_stream, object begin_date [,object end_date]);</insert>

13549

<dialog title="Insert mcal_list_events">mcal_list_events(%0, %1, %2);</dialog>

13550

13551

</function>

13552

13553

<description>Returns the next recurrence of the event</description>

13554

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13555

<param name="weekstart" required="1" vallist="0" default="" type="int">weekstart</param>

13556

13557

13558

<insert>mcal_next_recurrence(int stream, int weekstart, array next);</insert>

13559

<dialog title="Insert mcal_next_recurrence">mcal_next_recurrence(%0, %1, %2);</dialog>

13560

13561

</function>

13562

13563

<description>Opens up an MCAL connection</description>

13564

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

13565

<param name="username" required="1" vallist="0" default="" type="string">username</param>

13566

<param name="password" required="1" vallist="0" default="" type="string">password</param>

13567

<param name="options" required="0" vallist="0" default="" type="int">options</param>

13568

13569

<insert>mcal_open(string calendar, string username, string password [,int options]);</insert>

13570

13571

13572

</function>

13573

13574

<description>Opens up a persistent MCAL connection</description>

13575

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

13576

<param name="username" required="1" vallist="0" default="" type="string">username</param>

13577

<param name="password" required="1" vallist="0" default="" type="string">password</param>

13578

<param name="options" required="0" vallist="0" default="" type="int">options</param>

13579

13580

<insert>mcal_popen(string calendar, string username, string password [,int options]);</insert>

13581

<dialog title="Insert mcal_popen">mcal_popen(%0, %1, %2, %3);</dialog>

13582

13583

</function>

13584

13585

<description>Rename an MCAL calendar </description>

13586

<param name="stream" required="1" vallist="0" default="" type="int">stream</param>

13587

13588

13589

<return type="string">string</return>

13590

<insert>mcal_rename_calendar(int stream, string old_name, string new_name);</insert>

13591

<dialog title="Insert mcal_rename_calendar">mcal_rename_calendar(%0, %1, %2);</dialog>

13592

13593

</function>

13594

13595

<description>Reopens an MCAL connection</description>

13596

<param name="calendar" required="1" vallist="0" default="" type="string">calendar</param>

13597

<param name="options" required="0" vallist="0" default="" type="int">options</param>

13598

13599

<insert>mcal_reopen(string calendar [,int options]);</insert>

13600

<dialog title="Insert mcal_reopen">mcal_reopen(%0, %1);</dialog>

13601

13602

</function>

13603

13604

<description>Turn off an alarm for an event</description>

13605

13606

13607

<insert>mcal_snooze(int id);</insert>

13608

<dialog title="Insert mcal_snooze">mcal_snooze(%0);</dialog>

13609

13610

</function>

13611

13612

<description>Modify an existing event in an MCAL calendar</description>

13613

<param name="mcal_stream" required="1" vallist="0" default="" type="int">mcal_stream</param>

13614

13615

<insert>mcal_store_event(int mcal_stream);</insert>

13616

<dialog title="Insert mcal_store_event">mcal_store_event(%0);</dialog>

13617

13618

</function>

13619

13620

13621

Returns </description>

13622

13623

<param name="minutes" required="1" vallist="0" default="" type="int">minutes</param>

13624

<param name="seconds" required="1" vallist="0" default="" type="int">seconds</param>

13625

13626

<insert>mcal_time_valid(int hour, int minutes, int seconds);</insert>

13627

<dialog title="Insert mcal_time_valid">mcal_time_valid(%0, %1, %2);</dialog>

13628

13629

</function>

13630

13631

13632

Returns the week number of the given date

13633

</description>

13634

13635

<param name="month" required="1" vallist="0" default="" type="int">month</param>

13636

13637

13638

<insert>mcal_week_of_year(int day, int month, int year);</insert>

13639

13640

13641

</function>

13642

</group>

13643

13644

13645

<description>Encrypt/decrypt data in CBC mode</description>

13646

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13647

13648

13649

13650

13651

<return type="string">string</return>

13652

<insert>mcrypt_cbc(int cipher, string key, string data, int mode [,string iv]);</insert>

13653

<dialog title="Insert mcrypt_cbc">mcrypt_cbc(%0, %1, %2, %3, %4);</dialog>

13654

13655

</function>

13656

13657

<description>Encrypt/decrypt data in CFB mode</description>

13658

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13659

13660

13661

13662

13663

<return type="string">string</return>

13664

<insert>mcrypt_cfb(int cipher, string key, string data, int mode, string iv);</insert>

13665

<dialog title="Insert mcrypt_cfb">mcrypt_cfb(%0, %1, %2, %3, %4);</dialog>

13666

13667

</function>

13668

13669

13670

Create an initialization vector (IV) from a random source

13671

</description>

13672

13673

<param name="source" required="1" vallist="0" default="" type="int">source</param>

13674

<return type="string">string</return>

13675

<insert>mcrypt_create_iv(int size, int source);</insert>

13676

<dialog title="Insert mcrypt_create_iv">mcrypt_create_iv(%0, %1);</dialog>

13677

13678

</function>

13679

13680

<description>Decrypts crypttext with given parameters</description>

13681

<param name="cipher" required="1" vallist="0" default="" type="string">cipher</param>

13682

13683

13684

13685

13686

<return type="string">string</return>

13687

<insert>mcrypt_decrypt(string cipher, string key, string data, string mode [,string iv]);</insert>

13688

<dialog title="Insert mcrypt_decrypt">mcrypt_decrypt(%0, %1, %2, %3, %4);</dialog>

13689

13690

</function>

13691

13692

<description>Encrypt/decrypt data in ECB mode</description>

13693

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13694

13695

13696

13697

<return type="string">string</return>

13698

<insert>mcrypt_ecb(int cipher, string key, string data, int mode);</insert>

13699

<dialog title="Insert mcrypt_ecb">mcrypt_ecb(%0, %1, %2, %3);</dialog>

13700

13701

</function>

13702

13703

<description>Returns the name of the opened algorithm</description>

13704

13705

<return type="string">string</return>

13706

<insert>mcrypt_enc_get_algorithms_name(resource td);</insert>

13707

<dialog title="Insert mcrypt_enc_get_algorithms_name">mcrypt_enc_get_algorithms_name(%0);</dialog>

13708

13709

</function>

13710

13711

<description>Returns the blocksize of the opened algorithm</description>

13712

13713

13714

<insert>mcrypt_enc_get_block_size(resource td);</insert>

13715

<dialog title="Insert mcrypt_enc_get_block_size">mcrypt_enc_get_block_size(%0);</dialog>

13716

13717

</function>

13718

13719

<description>Returns the size of the IV of the opened algorithm</description>

13720

13721

13722

<insert>mcrypt_enc_get_iv_size(resource td);</insert>

13723

<dialog title="Insert mcrypt_enc_get_iv_size">mcrypt_enc_get_iv_size(%0);</dialog>

13724

13725

</function>

13726

13727

<description>Returns the maximum supported keysize of the opened mode</description>

13728

13729

13730

<insert>mcrypt_enc_get_key_size(resource td);</insert>

13731

<dialog title="Insert mcrypt_enc_get_key_size">mcrypt_enc_get_key_size(%0);</dialog>

13732

13733

</function>

13734

13735

<description>Returns the name of the opened mode</description>

13736

13737

<return type="string">string</return>

13738

<insert>mcrypt_enc_get_modes_name(resource td);</insert>

13739

<dialog title="Insert mcrypt_enc_get_modes_name">mcrypt_enc_get_modes_name(%0);</dialog>

13740

13741

</function>

13742

13743

<description>Returns an array with the supported keysizes of the opened algorithm</description>

13744

13745

<return type="array">array</return>

13746

<insert>mcrypt_enc_get_supported_key_sizes(resource td);</insert>

13747

<dialog title="Insert mcrypt_enc_get_supported_key_sizes">mcrypt_enc_get_supported_key_sizes(%0);</dialog>

13748

13749

</function>

13750

13751

<description>Checks whether the encryption of the opened mode works on blocks</description>

13752

13753

13754

<insert>mcrypt_enc_is_block_algorithm_mode(resource td);</insert>

13755

<dialog title="Insert mcrypt_enc_is_block_algorithm_mode">mcrypt_enc_is_block_algorithm_mode(%0);</dialog>

13756

13757

</function>

13758

13759

<description>Checks whether the algorithm of the opened mode is a block algorithm</description>

13760

13761

13762

<insert>mcrypt_enc_is_block_algorithm(resource td);</insert>

13763

<dialog title="Insert mcrypt_enc_is_block_algorithm">mcrypt_enc_is_block_algorithm(%0);</dialog>

13764

13765

</function>

13766

13767

<description>Checks whether the opened mode outputs blocks</description>

13768

13769

13770

<insert>mcrypt_enc_is_block_mode(resource td);</insert>

13771

<dialog title="Insert mcrypt_enc_is_block_mode">mcrypt_enc_is_block_mode(%0);</dialog>

13772

13773

</function>

13774

13775

<description>This function runs a self test on the opened module</description>

13776

13777

13778

<insert>mcrypt_enc_self_test(resource td);</insert>

13779

<dialog title="Insert mcrypt_enc_self_test">mcrypt_enc_self_test(%0);</dialog>

13780

13781

</function>

13782

13783

<description>Encrypts plaintext with given parameters</description>

13784

<param name="cipher" required="1" vallist="0" default="" type="string">cipher</param>

13785

13786

13787

13788

13789

<return type="string">string</return>

13790

<insert>mcrypt_encrypt(string cipher, string key, string data, string mode [,string iv]);</insert>

13791

<dialog title="Insert mcrypt_encrypt">mcrypt_encrypt(%0, %1, %2, %3, %4);</dialog>

13792

13793

</function>

13794

13795

13796

This function deinitializes an encryption module

13797

</description>

13798

13799

13800

<insert>mcrypt_generic_deinit(resource td);</insert>

13801

<dialog title="Insert mcrypt_generic_deinit">mcrypt_generic_deinit(%0);</dialog>

13802

13803

</function>

13804

13805

<description>This function terminates encryption</description>

13806

13807

13808

<insert>mcrypt_generic_end(resource td);</insert>

13809

<dialog title="Insert mcrypt_generic_end">mcrypt_generic_end(%0);</dialog>

13810

13811

</function>

13812

13813

<description>This function initializes all buffers needed for encryption</description>

13814

13815

13816

13817

13818

<insert>mcrypt_generic_init(resource td, string key, string iv);</insert>

13819

<dialog title="Insert mcrypt_generic_init">mcrypt_generic_init(%0, %1, %2);</dialog>

13820

13821

</function>

13822

13823

<description>This function encrypts data</description>

13824

13825

13826

<return type="string">string</return>

13827

<insert>mcrypt_generic(resource td, string data);</insert>

13828

<dialog title="Insert mcrypt_generic">mcrypt_generic(%0, %1);</dialog>

13829

13830

</function>

13831

13832

<description>Get the block size of the specified cipher</description>

13833

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13834

13835

<insert>mcrypt_get_block_size(int cipher);</insert>

13836

<dialog title="Insert mcrypt_get_block_size">mcrypt_get_block_size(%0);</dialog>

13837

13838

</function>

13839

13840

<description>Get the name of the specified cipher</description>

13841

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13842

<return type="string">string</return>

13843

<insert>mcrypt_get_cipher_name(int cipher);</insert>

13844

<dialog title="Insert mcrypt_get_cipher_name">mcrypt_get_cipher_name(%0);</dialog>

13845

13846

</function>

13847

13848

13849

Returns the size of the IV belonging to a specific cipher/mode combination

13850

</description>

13851

13852

13853

<insert>mcrypt_get_iv_size(resource td);</insert>

13854

<dialog title="Insert mcrypt_get_iv_size">mcrypt_get_iv_size(%0);</dialog>

13855

13856

</function>

13857

13858

<description>Get the key size of the specified cipher</description>

13859

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13860

13861

<insert>mcrypt_get_key_size(int cipher);</insert>

13862

<dialog title="Insert mcrypt_get_key_size">mcrypt_get_key_size(%0);</dialog>

13863

13864

</function>

13865

13866

<description>Get an array of all supported ciphers</description>

13867

13868

<return type="array">array</return>

13869

<insert>mcrypt_list_algorithms([string lib_dir]);</insert>

13870

<dialog title="Insert mcrypt_list_algorithms">mcrypt_list_algorithms(%0);</dialog>

13871

13872

</function>

13873

13874

<description>Get an array of all supported modes</description>

13875

13876

<return type="array">array</return>

13877

<insert>mcrypt_list_modes([string lib_dir]);</insert>

13878

<dialog title="Insert mcrypt_list_modes">mcrypt_list_modes(%0);</dialog>

13879

13880

</function>

13881

13882

13883

Close the mcrypt module

13884

</description>

13885

13886

13887

<insert>mcrypt_module_close(resource td);</insert>

13888

<dialog title="Insert mcrypt_module_close">mcrypt_module_close(%0);</dialog>

13889

13890

</function>

13891

13892

<description>Returns the blocksize of the specified algorithm</description>

13893

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13894

13895

13896

<insert>mcrypt_module_get_algo_block_size(string algorithm [,string lib_dir]);</insert>

13897

<dialog title="Insert mcrypt_module_get_algo_block_size">mcrypt_module_get_algo_block_size(%0, %1);</dialog>

13898

13899

</function>

13900

13901

<description>Returns the maximum supported keysize of the opened mode</description>

13902

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13903

13904

13905

<insert>mcrypt_module_get_algo_key_size(string algorithm [,string lib_dir]);</insert>

13906

<dialog title="Insert mcrypt_module_get_algo_key_size">mcrypt_module_get_algo_key_size(%0, %1);</dialog>

13907

13908

</function>

13909

13910

<description>Returns an array with the supported keysizes of the opened algorithm</description>

13911

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13912

13913

<return type="array">array</return>

13914

<insert>mcrypt_module_get_supported_key_sizes(string algorithm [,string lib_dir]);</insert>

13915

<dialog title="Insert mcrypt_module_get_supported_key_sizes">mcrypt_module_get_supported_key_sizes(%0, %1);</dialog>

13916

13917

</function>

13918

13919

<description>This function returns if the the specified module is a block algorithm or not</description>

13920

13921

13922

13923

<insert>mcrypt_module_is_block_algorithm_mode(string mode [,string lib_dir]);</insert>

13924

<dialog title="Insert mcrypt_module_is_block_algorithm_mode">mcrypt_module_is_block_algorithm_mode(%0, %1);</dialog>

13925

13926

</function>

13927

13928

<description>This function checks whether the specified algorithm is a block algorithm</description>

13929

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13930

13931

13932

<insert>mcrypt_module_is_block_algorithm(string algorithm [,string lib_dir]);</insert>

13933

<dialog title="Insert mcrypt_module_is_block_algorithm">mcrypt_module_is_block_algorithm(%0, %1);</dialog>

13934

13935

</function>

13936

13937

<description>This function returns if the the specified mode outputs blocks or not</description>

13938

13939

13940

13941

<insert>mcrypt_module_is_block_mode(string mode [,string lib_dir]);</insert>

13942

<dialog title="Insert mcrypt_module_is_block_mode">mcrypt_module_is_block_mode(%0, %1);</dialog>

13943

13944

</function>

13945

13946

<description>Opens the module of the algorithm and the mode to be used</description>

13947

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13948

<param name="algorithm_directory" required="1" vallist="0" default="" type="string">algorithm_directory</param>

13949

13950

<param name="mode_directory" required="1" vallist="0" default="" type="string">mode_directory</param>

13951

<return type="resource">resource</return>

13952

<insert>mcrypt_module_open(string algorithm, string algorithm_directory, string mode, string mode_directory);</insert>

13953

<dialog title="Insert mcrypt_module_open">mcrypt_module_open(%0, %1, %2, %3);</dialog>

13954

13955

</function>

13956

13957

<description>This function runs a self test on the specified module</description>

13958

<param name="algorithm" required="1" vallist="0" default="" type="string">algorithm</param>

13959

13960

13961

<insert>mcrypt_module_self_test(string algorithm [,string lib_dir]);</insert>

13962

<dialog title="Insert mcrypt_module_self_test">mcrypt_module_self_test(%0, %1);</dialog>

13963

13964

</function>

13965

13966

<description>Encrypt/decrypt data in OFB mode</description>

13967

<param name="cipher" required="1" vallist="0" default="" type="int">cipher</param>

13968

13969

13970

13971

13972

<return type="string">string</return>

13973

<insert>mcrypt_ofb(int cipher, string key, string data, int mode, string iv);</insert>

13974

<dialog title="Insert mcrypt_ofb">mcrypt_ofb(%0, %1, %2, %3, %4);</dialog>

13975

13976

</function>

13977

13978

<description>Decrypt data</description>

13979

13980

13981

<return type="string">string</return>

13982

<insert>mdecrypt_generic(resource td, string data);</insert>

13983

<dialog title="Insert mdecrypt_generic">mdecrypt_generic(%0, %1);</dialog>

13984

13985

</function>

13986

</group>

13987

13988

13989

<description> Add an MCVE user using usersetup structure </description>

13990

13991

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

13992

<param name="usersetup" required="1" vallist="0" default="" type="int">usersetup</param>

13993

13994

<insert>mcve_adduser(resource conn, string admin_password, int usersetup);</insert>

13995

<dialog title="Insert mcve_adduser">mcve_adduser(%0, %1, %2);</dialog>

13996

13997

</function>

13998

13999

<description> Add a value to user configuration structure </description>

14000

<param name="usersetup" required="1" vallist="0" default="" type="resource">usersetup</param>

14001

<param name="argtype" required="1" vallist="0" default="" type="int">argtype</param>

14002

<param name="argval" required="1" vallist="0" default="" type="string">argval</param>

14003

14004

<insert>mcve_adduserarg(resource usersetup, int argtype, string argval);</insert>

14005

<dialog title="Insert mcve_adduserarg">mcve_adduserarg(%0, %1, %2);</dialog>

14006

14007

</function>

14008

14009

<description> Get unsettled batch totals </description>

14010

14011

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14012

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14013

14014

<insert>mcve_bt(resource conn, string username, string password);</insert>

14015

14016

14017

</function>

14018

14019

<description> Check to see if a transaction has completed </description>

14020

14021

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14022

14023

<insert>mcve_checkstatus(resource conn, int identifier);</insert>

14024

<dialog title="Insert mcve_checkstatus">mcve_checkstatus(%0, %1);</dialog>

14025

14026

</function>

14027

14028

<description> Verify Password </description>

14029

14030

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14031

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14032

14033

<insert>mcve_chkpwd(resource conn, string username, string password);</insert>

14034

<dialog title="Insert mcve_chkpwd">mcve_chkpwd(%0, %1, %2);</dialog>

14035

14036

</function>

14037

14038

<description> Change the system administrator's password </description>

14039

14040

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14041

<param name="new_password" required="1" vallist="0" default="" type="string">new_password</param>

14042

14043

<insert>mcve_chngpwd(resource conn, string admin_password, string new_password);</insert>

14044

<dialog title="Insert mcve_chngpwd">mcve_chngpwd(%0, %1, %2);</dialog>

14045

14046

</function>

14047

14048

<description> Number of complete authorizations in queue, returning an array of their identifiers </description>

14049

14050

<param name="&array" required="1" vallist="0" default="" type="int">&array</param>

14051

14052

<insert>mcve_completeauthorizations(resource conn, int &array);</insert>

14053

<dialog title="Insert mcve_completeauthorizations">mcve_completeauthorizations(%0, %1);</dialog>

14054

14055

</function>

14056

14057

<description> Establish the connection to MCVE </description>

14058

14059

14060

<insert>mcve_connect(resource conn);</insert>

14061

<dialog title="Insert mcve_connect">mcve_connect(%0);</dialog>

14062

14063

</function>

14064

14065

<description> Get a textual representation of why a connection failed </description>

14066

14067

<return type="string">string</return>

14068

<insert>mcve_connectionerror(resource conn);</insert>

14069

<dialog title="Insert mcve_connectionerror">mcve_connectionerror(%0);</dialog>

14070

14071

</function>

14072

14073

<description> Delete specified transaction from MCVE_CONN structure </description>

14074

14075

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14076

14077

<insert>mcve_deleteresponse(resource conn, int identifier);</insert>

14078

<dialog title="Insert mcve_deleteresponse">mcve_deleteresponse(%0, %1);</dialog>

14079

14080

</function>

14081

14082

<description> Delete specified transaction from MCVE_CONN structure </description>

14083

14084

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14085

14086

<insert>mcve_deletetrans(resource conn, int identifier);</insert>

14087

<dialog title="Insert mcve_deletetrans">mcve_deletetrans(%0, %1);</dialog>

14088

14089

</function>

14090

14091

<description> Deallocate data associated with usersetup structure </description>

14092

<param name="usersetup" required="1" vallist="0" default="" type="resource">usersetup</param>

14093

14094

<insert>mcve_deleteusersetup(resource usersetup);</insert>

14095

<dialog title="Insert mcve_deleteusersetup">mcve_deleteusersetup(%0);</dialog>

14096

14097

</function>

14098

14099

<description> Delete an MCVE user account </description>

14100

14101

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14102

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14103

14104

<insert>mcve_deluser(resource conn, string admin_password, string username);</insert>

14105

<dialog title="Insert mcve_deluser">mcve_deluser(%0, %1, %2);</dialog>

14106

14107

</function>

14108

14109

<description> Destroy the connection and MCVE_CONN structure </description>

14110

14111

14112

<insert>mcve_destroyconn(resource conn);</insert>

14113

<dialog title="Insert mcve_destroyconn">mcve_destroyconn(%0);</dialog>

14114

14115

</function>

14116

14117

<description> Free memory associated with IP/SSL connectivity </description>

14118

14119

<insert>mcve_destroyengine();</insert>

14120

<dialog title="Insert mcve_destroyengine">mcve_destroyengine();</dialog>

14121

14122

</function>

14123

14124

<description> Disable an active MCVE user account </description>

14125

14126

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14127

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14128

14129

<insert>mcve_disableuser(resource conn, string admin_password, string username);</insert>

14130

<dialog title="Insert mcve_disableuser">mcve_disableuser(%0, %1, %2);</dialog>

14131

14132

</function>

14133

14134

<description> Edit MCVE user using usersetup structure </description>

14135

14136

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14137

<param name="usersetup" required="1" vallist="0" default="" type="int">usersetup</param>

14138

14139

<insert>mcve_edituser(resource conn, string admin_password, int usersetup);</insert>

14140

<dialog title="Insert mcve_edituser">mcve_edituser(%0, %1, %2);</dialog>

14141

14142

</function>

14143

14144

<description> Enable an inactive MCVE user account </description>

14145

14146

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14147

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14148

14149

<insert>mcve_enableuser(resource conn, string admin_password, string username);</insert>

14150

<dialog title="Insert mcve_enableuser">mcve_enableuser(%0, %1, %2);</dialog>

14151

14152

</function>

14153

14154

<description> Send a FORCE to MCVE. (typically, a phone-authorization) </description>

14155

14156

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14157

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14158

<param name="trackdata" required="1" vallist="0" default="" type="string">trackdata</param>

14159

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14160

<param name="expdate" required="1" vallist="0" default="" type="string">expdate</param>

14161

<param name="amount" required="1" vallist="0" default="" type="float">amount</param>

14162

<param name="authcode" required="1" vallist="0" default="" type="string">authcode</param>

14163

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14164

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14165

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14166

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14167

14168

<insert>mcve_force(resiurce conn, string username, string password, string trackdata, string account, string expdate, float amount, string authcode, string comments, string clerkid, string stationid, int ptrannum);</insert>

14169

<dialog title="Insert mcve_force">mcve_force(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10, %11);</dialog>

14170

14171

</function>

14172

14173

<description> Get a specific cell from a comma delimited response by column name </description>

14174

14175

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14176

<param name="column" required="1" vallist="0" default="" type="string">column</param>

14177

14178

<return type="string">string</return>

14179

<insert>mcve_getcell(resource conn, int identifier, string column, int row);</insert>

14180

<dialog title="Insert mcve_getcell">mcve_getcell(%0, %1, %2, %3);</dialog>

14181

14182

</function>

14183

14184

<description> Get a specific cell from a comma delimited response by column number </description>

14185

14186

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14187

<param name="column" required="1" vallist="0" default="" type="int">column</param>

14188

14189

<return type="string">string</return>

14190

<insert>mcve_getcellbynum(resource conn, int identifier, int column, int row);</insert>

14191

<dialog title="Insert mcve_getcellbynum">mcve_getcellbynum(%0, %1, %2, %3);</dialog>

14192

14193

</function>

14194

14195

<description> Get the RAW comma delimited data returned from MCVE </description>

14196

14197

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14198

<return type="string">string</return>

14199

<insert>mcve_getcommadelimited(resource conn, int identifier);</insert>

14200

<dialog title="Insert mcve_getcommadelimited">mcve_getcommadelimited(%0, %1);</dialog>

14201

14202

</function>

14203

14204

<description> Get the name of the column in a comma-delimited response </description>

14205

14206

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14207

<param name="column_num" required="1" vallist="0" default="" type="int">column_num</param>

14208

<return type="string">string</return>

14209

<insert>mcve_getheader(resource conn, int identifier, int column_num);</insert>

14210

<dialog title="Insert mcve_getheader">mcve_getheader(%0, %1, %2);</dialog>

14211

14212

</function>

14213

14214

<description> Grab a value from usersetup structure </description>

14215

<param name="usersetup" required="1" vallist="0" default="" type="resource">usersetup</param>

14216

<param name="argtype" required="1" vallist="0" default="" type="int">argtype</param>

14217

<return type="string">string</return>

14218

<insert>mcve_getuserarg(resource usersetup, int argtype);</insert>

14219

<dialog title="Insert mcve_getuserarg">mcve_getuserarg(%0, %1);</dialog>

14220

14221

</function>

14222

14223

<description> Get a user response parameter </description>

14224

14225

<param name="identifier" required="1" vallist="0" default="" type="long">identifier</param>

14226

14227

<return type="string">string</return>

14228

<insert>mcve_getuserparam(resource conn, long identifier, int key);</insert>

14229

<dialog title="Insert mcve_getuserparam">mcve_getuserparam(%0, %1, %2);</dialog>

14230

14231

</function>

14232

14233

<description> Audit MCVE for Failed transactions </description>

14234

14235

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14236

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14237

14238

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14239

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14240

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14241

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14242

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14243

<param name="startdate" required="1" vallist="0" default="" type="string">startdate</param>

14244

<param name="enddate" required="1" vallist="0" default="" type="string">enddate</param>

14245

14246

<insert>mcve_gft(resource conn, string username, string password, int type, string account, string clerkid, string stationid, string comments, int ptrannum, string startdate, string enddate);</insert>

14247

14248

14249

</function>

14250

14251

<description> Audit MCVE for settled transactions </description>

14252

14253

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14254

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14255

14256

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14257

<param name="batch" required="1" vallist="0" default="" type="string">batch</param>

14258

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14259

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14260

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14261

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14262

<param name="startdate" required="1" vallist="0" default="" type="string">startdate</param>

14263

<param name="enddate" required="1" vallist="0" default="" type="string">enddate</param>

14264

14265

<insert>mcve_gl(int conn, string username, string password, int type, string account, string batch, string clerkid, string stationid, string comments, int ptrannum, string startdate, string enddate);</insert>

14266

14267

14268

</function>

14269

14270

<description> Audit MCVE for Unsettled Transactions </description>

14271

14272

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14273

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14274

14275

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14276

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14277

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14278

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14279

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14280

<param name="startdate" required="1" vallist="0" default="" type="string">startdate</param>

14281

<param name="enddate" required="1" vallist="0" default="" type="string">enddate</param>

14282

14283

<insert>mcve_gut(resource conn, string username, string password, int type, string account, string clerkid, string stationid, string comments, int ptrannum, string startdate, string enddate);</insert>

14284

14285

14286

</function>

14287

14288

<description> Create and initialize an MCVE_CONN structure </description>

14289

<return type="resource">resource</return>

14290

<insert>mcve_initconn();</insert>

14291

<dialog title="Insert mcve_initconn">mcve_initconn();</dialog>

14292

14293

</function>

14294

14295

<description> Ready the client for IP/SSL Communication </description>

14296

<param name="location" required="1" vallist="0" default="" type="string">location</param>

14297

14298

<insert>mcve_initengine(string location);</insert>

14299

<dialog title="Insert mcve_initengine">mcve_initengine(%0);</dialog>

14300

14301

</function>

14302

14303

<description> Initialize structure to store user data </description>

14304

<return type="resource">resource</return>

14305

<insert>mcve_initusersetup();</insert>

14306

<dialog title="Insert mcve_initusersetup">mcve_initusersetup();</dialog>

14307

14308

</function>

14309

14310

<description> Checks to see if response is comma delimited </description>

14311

14312

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14313

14314

<insert>mcve_iscommadelimited(resource conn, int identifier);</insert>

14315

<dialog title="Insert mcve_iscommadelimited">mcve_iscommadelimited(%0, %1);</dialog>

14316

14317

</function>

14318

14319

<description> List statistics for all users on MCVE system </description>

14320

14321

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14322

14323

<insert>mcve_liststats(resource conn, string admin_password);</insert>

14324

<dialog title="Insert mcve_liststats">mcve_liststats(%0, %1);</dialog>

14325

14326

</function>

14327

14328

<description> List all users on MCVE system </description>

14329

14330

<param name="admin_password" required="1" vallist="0" default="" type="string">admin_password</param>

14331

14332

<insert>mcve_listusers(resource conn, string admin_password);</insert>

14333

<dialog title="Insert mcve_listusers">mcve_listusers(%0, %1);</dialog>

14334

14335

</function>

14336

14337

<description> The maximum amount of time the API will attempt a connection to MCVE </description>

14338

14339

14340

14341

<insert>mcve_maxconntimeout(resource conn, int secs);</insert>

14342

<dialog title="Insert mcve_maxconntimeout">mcve_maxconntimeout(%0, %1);</dialog>

14343

14344

</function>

14345

14346

<description> Perform communication with MCVE (send/receive data) Non-blocking </description>

14347

14348

14349

<insert>mcve_monitor(resource conn);</insert>

14350

<dialog title="Insert mcve_monitor">mcve_monitor(%0);</dialog>

14351

14352

</function>

14353

14354

<description> Number of columns returned in a comma delimited response </description>

14355

14356

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14357

14358

<insert>mcve_numcolumns(resource conn, int identifier);</insert>

14359

<dialog title="Insert mcve_numcolumns">mcve_numcolumns(%0, %1);</dialog>

14360

14361

</function>

14362

14363

<description> Number of rows returned in a comma delimited response </description>

14364

14365

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14366

14367

<insert>mcve_numrows(resource conn, int identifier);</insert>

14368

<dialog title="Insert mcve_numrows">mcve_numrows(%0, %1);</dialog>

14369

14370

</function>

14371

14372

<description> Send an OVERRIDE to MCVE </description>

14373

14374

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14375

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14376

<param name="trackdata" required="1" vallist="0" default="" type="string">trackdata</param>

14377

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14378

<param name="expdate" required="1" vallist="0" default="" type="string">expdate</param>

14379

<param name="amount" required="1" vallist="0" default="" type="float">amount</param>

14380

<param name="street" required="1" vallist="0" default="" type="string">street</param>

14381

14382

14383

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14384

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14385

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14386

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14387

14388

<insert>mcve_override(resource conn, string username, string password, string trackdata, string account, string expdate, float amount, string street, string zip, string cv, string comments, string clerkid, string stationid, int ptrannum);</insert>

14389

<dialog title="Insert mcve_override">mcve_override(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10, %11, %12, %13);</dialog>

14390

14391

</function>

14392

14393

<description> Parse the comma delimited response so mcve_getcell, etc will work </description>

14394

14395

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14396

14397

<insert>mcve_parsecommadelimited(resource conn, int identifier);</insert>

14398

<dialog title="Insert mcve_parsecommadelimited">mcve_parsecommadelimited(%0, %1);</dialog>

14399

14400

</function>

14401

14402

<description> Send a ping request to MCVE </description>

14403

14404

14405

<insert>mcve_ping(resource conn);</insert>

14406

14407

14408

</function>

14409

14410

<description> Send a PREAUTHORIZATION to MCVE </description>

14411

14412

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14413

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14414

<param name="trackdata" required="1" vallist="0" default="" type="string">trackdata</param>

14415

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14416

<param name="expdate" required="1" vallist="0" default="" type="string">expdate</param>

14417

<param name="amount" required="1" vallist="0" default="" type="float">amount</param>

14418

<param name="street" required="1" vallist="0" default="" type="string">street</param>

14419

14420

14421

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14422

<param name="clerkid" required="1" vallist="0" default="" type=" string">clerkid</param>

14423

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14424

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14425

14426

<insert>mcve_preauth(resource conn, string username, string password, string trackdata, string account, string expdate, float amount, string street, string zip, string cv, string comments, string clerkid, string stationid, int ptrannum);</insert>

14427

<dialog title="Insert mcve_preauth">mcve_preauth(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10, %11, %12, %13);</dialog>

14428

14429

</function>

14430

14431

<description> Complete a PREAUTHORIZATION... Ready it for settlement </description>

14432

14433

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14434

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14435

<param name="finalamount" required="1" vallist="0" default="" type="float">finalamount</param>

14436

14437

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14438

14439

<insert>mcve_preauthcompletion(resource conn, string username, string password, float finalamount, int sid, int ptrannum);</insert>

14440

<dialog title="Insert mcve_preauthcompletion">mcve_preauthcompletion(%0, %1, %2, %3, %4, %5);</dialog>

14441

14442

</function>

14443

14444

<description> Audit MCVE for a list of transactions in the outgoing queue </description>

14445

14446

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14447

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14448

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14449

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14450

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14451

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14452

14453

<insert>mcve_qc(resource conn, string username, string password, string clerkid, string stationid, string comments, int ptrannum);</insert>

14454

14455

14456

</function>

14457

14458

<description> Get a custom response parameter </description>

14459

14460

<param name="identifier" required="1" vallist="0" default="" type="long">identifier</param>

14461

14462

<return type="string">string</return>

14463

<insert>mcve_responseparam(resource conn, long identifier, string key);</insert>

14464

<dialog title="Insert mcve_responseparam">mcve_responseparam(%0, %1, %2);</dialog>

14465

14466

</function>

14467

14468

<description> Issue a RETURN or CREDIT to MCVE </description>

14469

14470

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14471

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14472

<param name="trackdata" required="1" vallist="0" default="" type="string">trackdata</param>

14473

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14474

<param name="expdate" required="1" vallist="0" default="" type="string">expdate</param>

14475

<param name="amount" required="1" vallist="0" default="" type="float">amount</param>

14476

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14477

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14478

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14479

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14480

14481

<insert>mcve_return(int conn, string username, string password, string trackdata, string account, string expdate, float amount, string comments, string clerkid, string stationid, int ptrannum);</insert>

14482

<dialog title="Insert mcve_return">mcve_return(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9, %10);</dialog>

14483

14484

</function>

14485

14486

<description> Grab the exact return code from the transaction </description>

14487

14488

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14489

14490

<insert>mcve_returncode(resource conn, int identifier);</insert>

14491

<dialog title="Insert mcve_returncode">mcve_returncode(%0, %1);</dialog>

14492

14493

</function>

14494

14495

<description> Check to see if the transaction was successful </description>

14496

14497

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14498

14499

<insert>mcve_returnstatus(resource conn, int identifier);</insert>

14500

<dialog title="Insert mcve_returnstatus">mcve_returnstatus(%0, %1);</dialog>

14501

14502

</function>

14503

14504

14505

14506

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14507

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14508

<param name="trackdata" required="1" vallist="0" default="" type="string">trackdata</param>

14509

<param name="account" required="1" vallist="0" default="" type="string">account</param>

14510

<param name="expdate" required="1" vallist="0" default="" type="string">expdate</param>

14511

<param name="amount" required="1" vallist="0" default="" type="float">amount</param>

14512

<param name="street" required="1" vallist="0" default="" type="string">street</param>

14513

14514

14515

<param name="comments" required="1" vallist="0" default="" type="string">comments</param>

14516

<param name="clerkid" required="1" vallist="0" default="" type="string">clerkid</param>

14517

<param name="stationid" required="1" vallist="0" default="" type="string">stationid</param>

14518

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14519

14520

<insert>mcve_sale(resource conn, string username, string password, string trackdata, string account, string expdate, float amount, string street, string zip, string cv, string comments, string clerkid, string stationid, int ptrannum);</insert>

14521

14522

14523

</function>

14524

14525

<description> Set blocking/non-blocking mode for connection </description>

14526

14527

14528

14529

<insert>mcve_setblocking(resource conn, int tf);</insert>

14530

<dialog title="Insert mcve_setblocking">mcve_setblocking(%0, %1);</dialog>

14531

14532

</function>

14533

14534

<description> Set the connection method to Drop-File </description>

14535

14536

<param name="directory" required="1" vallist="0" default="" type="string">directory</param>

14537

14538

<insert>mcve_setdropfile(resource conn, string directory);</insert>

14539

<dialog title="Insert mcve_setdropfile">mcve_setdropfile(%0, %1);</dialog>

14540

14541

</function>

14542

14543

<description> Set the connection method to IP </description>

14544

14545

14546

14547

14548

<insert>mcve_setip(resource conn, string host, int port);</insert>

14549

<dialog title="Insert mcve_setip">mcve_setip(%0, %1, %2);</dialog>

14550

14551

</function>

14552

14553

<description> Set the connection method to SSL </description>

14554

14555

14556

14557

14558

<insert>mcve_setssl(resource conn, string host, int port);</insert>

14559

<dialog title="Insert mcve_setssl">mcve_setssl(%0, %1, %2);</dialog>

14560

14561

</function>

14562

14563

<description> Set maximum transaction time (per trans) </description>

14564

14565

<param name="seconds" required="1" vallist="0" default="" type="int">seconds</param>

14566

14567

<insert>mcve_settimeout(resource conn, int seconds);</insert>

14568

<dialog title="Insert mcve_settimeout">mcve_settimeout(%0, %1);</dialog>

14569

14570

</function>

14571

14572

<description> Issue a settlement command to do a batch deposit </description>

14573

14574

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14575

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14576

<param name="batch" required="1" vallist="0" default="" type="string">batch</param>

14577

14578

<insert>mcve_settle(resource conn, string username, string password, string batch);</insert>

14579

<dialog title="Insert mcve_settle">mcve_settle(%0, %1, %2, %3);</dialog>

14580

14581

</function>

14582

14583

<description> Get a textual representation of the return_avs </description>

14584

14585

<return type="string">string</return>

14586

<insert>mcve_text_avs(string code);</insert>

14587

14588

14589

</function>

14590

14591

<description> Get a textual representation of the return_code </description>

14592

14593

<return type="string">string</return>

14594

<insert>mcve_text_code(string code);</insert>

14595

14596

14597

</function>

14598

14599

<description> Get a textual representation of the return_cv </description>

14600

14601

<return type="string">string</return>

14602

14603

14604

14605

</function>

14606

14607

<description> Get the authorization number returned for the transaction (alpha-numeric) </description>

14608

14609

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14610

<return type="string">string</return>

14611

<insert>mcve_transactionauth(resource conn, int identifier);</insert>

14612

<dialog title="Insert mcve_transactionauth">mcve_transactionauth(%0, %1);</dialog>

14613

14614

</function>

14615

14616

<description> Get the Address Verification return status </description>

14617

14618

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14619

14620

<insert>mcve_transactionavs(resource conn, int identifier);</insert>

14621

<dialog title="Insert mcve_transactionavs">mcve_transactionavs(%0, %1);</dialog>

14622

14623

</function>

14624

14625

<description> Get the batch number associated with the transaction </description>

14626

14627

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14628

14629

<insert>mcve_transactionbatch(resource conn, int identifier);</insert>

14630

<dialog title="Insert mcve_transactionbatch">mcve_transactionbatch(%0, %1);</dialog>

14631

14632

</function>

14633

14634

<description> Get the CVC2/CVV2/CID return status </description>

14635

14636

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14637

14638

<insert>mcve_transactioncv(resource conn, int identifier);</insert>

14639

<dialog title="Insert mcve_transactioncv">mcve_transactioncv(%0, %1);</dialog>

14640

14641

</function>

14642

14643

<description> Get the unique system id for the transaction </description>

14644

14645

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14646

14647

<insert>mcve_transactionid(resource conn, int identifier);</insert>

14648

<dialog title="Insert mcve_transactionid">mcve_transactionid(%0, %1);</dialog>

14649

14650

</function>

14651

14652

<description> Get the ITEM number in the associated batch for this transaction </description>

14653

14654

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14655

14656

<insert>mcve_transactionitem(resource conn, int identifier);</insert>

14657

<dialog title="Insert mcve_transactionitem">mcve_transactionitem(%0, %1);</dialog>

14658

14659

</function>

14660

14661

<description> Check to see if outgoing buffer is clear </description>

14662

14663

14664

<insert>mcve_transactionssent(resource conn);</insert>

14665

<dialog title="Insert mcve_transactionssent">mcve_transactionssent(%0);</dialog>

14666

14667

</function>

14668

14669

<description> Get verbiage (text) return from MCVE or processing institution </description>

14670

14671

<param name="identifier" required="1" vallist="0" default="" type="int">identifier</param>

14672

<return type="string">string</return>

14673

<insert>mcve_transactiontext(resource conn, int identifier);</insert>

14674

<dialog title="Insert mcve_transactiontext">mcve_transactiontext(%0, %1);</dialog>

14675

14676

</function>

14677

14678

<description> Number of transactions in client-queue </description>

14679

14680

14681

<insert>mcve_transinqueue(resource conn);</insert>

14682

<dialog title="Insert mcve_transinqueue">mcve_transinqueue(%0);</dialog>

14683

14684

</function>

14685

14686

<description> Start a new transaction </description>

14687

14688

14689

<insert>mcve_transnew(resource conn);</insert>

14690

<dialog title="Insert mcve_transnew">mcve_transnew(%0);</dialog>

14691

14692

</function>

14693

14694

<description> Add a parameter to a transaction </description>

14695

14696

<param name="identifier" required="1" vallist="0" default="" type="long">identifier</param>

14697

14698

14699

<insert>mcve_transparam(resource conn, long identifier, int key);</insert>

14700

<dialog title="Insert mcve_transparam">mcve_transparam(%0, %1, %2);</dialog>

14701

14702

</function>

14703

14704

<description> Finalize and send the transaction </description>

14705

14706

<param name="identifier" required="1" vallist="0" default="" type="long">identifier</param>

14707

14708

<insert>mcve_transsend(resource conn, long identifier);</insert>

14709

<dialog title="Insert mcve_transsend">mcve_transsend(%0, %1);</dialog>

14710

14711

</function>

14712

14713

<description> Get a list of all Unsettled batches </description>

14714

14715

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14716

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14717

14718

<insert>mcve_ub(resource conn, string username, string password);</insert>

14719

14720

14721

</function>

14722

14723

<description> Wait x microsecs </description>

14724

<param name="microsecs" required="1" vallist="0" default="" type="long">microsecs</param>

14725

14726

<insert>mcve_uwait(long microsecs);</insert>

14727

<dialog title="Insert mcve_uwait">mcve_uwait(%0);</dialog>

14728

14729

</function>

14730

14731

<description> Set whether or not to PING upon connect to verify connection </description>

14732

14733

14734

14735

<insert>mcve_verifyconnection(resource conn, int tf);</insert>

14736

<dialog title="Insert mcve_verifyconnection">mcve_verifyconnection(%0, %1);</dialog>

14737

14738

</function>

14739

14740

<description> Set whether or not to verify the server ssl certificate </description>

14741

14742

14743

14744

<insert>mcve_verifysslcert(resource conn, int tf);</insert>

14745

<dialog title="Insert mcve_verifysslcert">mcve_verifysslcert(%0, %1);</dialog>

14746

14747

</function>

14748

14749

<description> VOID a transaction in the settlement queue </description>

14750

14751

<param name="username" required="1" vallist="0" default="" type="string">username</param>

14752

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14753

14754

<param name="ptrannum" required="1" vallist="0" default="" type="int">ptrannum</param>

14755

14756

<insert>mcve_void(resource conn, string username, string password, int sid, int ptrannum);</insert>

14757

14758

14759

</function>

14760

</group>

14761

14762

14763

<description>Get the highest available hash id</description>

14764

14765

<insert>mhash_count();</insert>

14766

<dialog title="Insert mhash_count">mhash_count();</dialog>

14767

14768

</function>

14769

14770

<description>Get the block size of the specified hash</description>

14771

14772

14773

<insert>mhash_get_block_size(int hash);</insert>

14774

<dialog title="Insert mhash_get_block_size">mhash_get_block_size(%0);</dialog>

14775

14776

</function>

14777

14778

<description>Get the name of the specified hash</description>

14779

14780

<return type="string">string</return>

14781

<insert>mhash_get_hash_name(int hash);</insert>

14782

<dialog title="Insert mhash_get_hash_name">mhash_get_hash_name(%0);</dialog>

14783

14784

</function>

14785

14786

<description>Generates a key</description>

14787

14788

<param name="password" required="1" vallist="0" default="" type="string">password</param>

14789

14790

<param name="bytes" required="1" vallist="0" default="" type="int">bytes</param>

14791

<return type="string">string</return>

14792

<insert>mhash_keygen_s2k(int hash, string password, string salt, int bytes);</insert>

14793

<dialog title="Insert mhash_keygen_s2k">mhash_keygen_s2k(%0, %1, %2, %3);</dialog>

14794

14795

</function>

14796

14797

<description>Compute hash</description>

14798

14799

14800

14801

<return type="string">string</return>

14802

<insert>mhash(int hash, string data [,string key]);</insert>

14803

<dialog title="Insert mhash">mhash(%0, %1, %2);</dialog>

14804

14805

</function>

14806

</group>

14807

14808

14809

<description>Detect MIME Content-type for a file</description>

14810

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

14811

<return type="string">string</return>

14812

<insert>mime_content_type(string filename);</insert>

14813

<dialog title="Insert mime_content_type">mime_content_type(%0);</dialog>

14814

14815

</function>

14816

</group>

14817

14818

14819

14820

Set cubic threshold (?)

14821

</description>

14822

<param name="threshold" required="1" vallist="0" default="" type="int">threshold</param>

14823

14824

<insert>ming_setcubicthreshold(int threshold);</insert>

14825

<dialog title="Insert ming_setcubicthreshold">ming_setcubicthreshold(%0);</dialog>

14826

14827

</function>

14828

14829

14830

Set scale (?)

14831

</description>

14832

<param name="scale" required="1" vallist="0" default="" type="int">scale</param>

14833

14834

<insert>ming_setscale(int scale);</insert>

14835

<dialog title="Insert ming_setscale">ming_setscale(%0);</dialog>

14836

14837

</function>

14838

14839

14840

Use SWF version (?)

14841

</description>

14842

<param name="version" required="1" vallist="0" default="" type="int">version</param>

14843

14844

<insert>ming_useswfversion(int version);</insert>

14845

<dialog title="Insert ming_useswfversion">ming_useswfversion(%0);</dialog>

14846

14847

</function>

14848

14849

<description>Creates a new Action.</description>

14850

<param name="script" required="1" vallist="0" default="" type="string">script</param>

14851

14852

<insert>SWFAction(string script);</insert>

14853

<dialog title="Insert SWFAction">SWFAction(%0);</dialog>

14854

14855

</function>

14856

<function name="SWFBitmap->getHeight">

14857

<description>Returns the bitmap's height.</description>

14858

14859

<insert>SWFBitmap->getHeight();</insert>

14860

<dialog title="Insert SWFBitmap->getHeight">SWFBitmap->getHeight();</dialog>

14861

14862

</function>

14863

<function name="SWFBitmap->getWidth">

14864

<description>Returns the bitmap's width.</description>

14865

14866

<insert>SWFBitmap->getWidth();</insert>

14867

<dialog title="Insert SWFBitmap->getWidth">SWFBitmap->getWidth();</dialog>

14868

14869

</function>

14870

14871

<description>Loads Bitmap object</description>

14872

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

14873

<param name="alphafilename" required="0" vallist="0" default="" type="int">alphafilename</param>

14874

14875

<insert>SWFBitmap(string filename [,int alphafilename]);</insert>

14876

<dialog title="Insert SWFBitmap">SWFBitmap(%0, %1);</dialog>

14877

14878

</function>

14879

14880

14881

Returns the action flag for keyPress(char)

14882

</description>

14883

14884

14885

<insert>swfbutton_keypress(string str);</insert>

14886

<dialog title="Insert swfbutton_keypress">swfbutton_keypress(%0);</dialog>

14887

14888

</function>

14889

<function name="SWFbutton->addAction">

14890

<description>Adds an action</description>

14891

<param name="action" required="1" vallist="0" default="" type="ressource">action</param>

14892

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

14893

14894

<insert>SWFbutton->addAction(ressource action, int flags);</insert>

14895

<dialog title="Insert SWFbutton->addAction">SWFbutton->addAction(%0, %1);</dialog>

14896

14897

</function>

14898

<function name="SWFbutton->addShape">

14899

<description>Adds a shape to a button</description>

14900

<param name="shape" required="1" vallist="0" default="" type="ressource">shape</param>

14901

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

14902

14903

<insert>SWFbutton->addShape(ressource shape, int flags);</insert>

14904

<dialog title="Insert SWFbutton->addShape">SWFbutton->addShape(%0, %1);</dialog>

14905

14906

</function>

14907

<function name="SWFbutton->setAction">

14908

<description>Sets the action</description>

14909

<param name="action" required="1" vallist="0" default="" type="ressource">action</param>

14910

14911

<insert>SWFbutton->setAction(ressource action);</insert>

14912

<dialog title="Insert SWFbutton->setAction">SWFbutton->setAction(%0);</dialog>

14913

14914

</function>

14915

<function name="SWFbutton->setdown">

14916

<description>Alias for addShape(shape, SWFBUTTON_DOWN))</description>

14917

<param name="shape" required="1" vallist="0" default="" type="ressource">shape</param>

14918

14919

<insert>SWFbutton->setdown(ressource shape);</insert>

14920

<dialog title="Insert SWFbutton->setdown">SWFbutton->setdown(%0);</dialog>

14921

14922

</function>

14923

<function name="SWFbutton->setHit">

14924

<description>Alias for addShape(shape, SWFBUTTON_HIT)</description>

14925

<param name="shape" required="1" vallist="0" default="" type="ressource">shape</param>

14926

14927

<insert>SWFbutton->setHit(ressource shape);</insert>

14928

<dialog title="Insert SWFbutton->setHit">SWFbutton->setHit(%0);</dialog>

14929

14930

</function>

14931

<function name="SWFbutton->setOver">

14932

<description>Alias for addShape(shape, SWFBUTTON_OVER)</description>

14933

<param name="shape" required="1" vallist="0" default="" type="ressource">shape</param>

14934

14935

<insert>SWFbutton->setOver(ressource shape);</insert>

14936

<dialog title="Insert SWFbutton->setOver">SWFbutton->setOver(%0);</dialog>

14937

14938

</function>

14939

<function name="SWFbutton->setUp">

14940

<description>Alias for addShape(shape, SWFBUTTON_UP)</description>

14941

<param name="shape" required="1" vallist="0" default="" type="ressource">shape</param>

14942

14943

<insert>SWFbutton->setUp(ressource shape);</insert>

14944

<dialog title="Insert SWFbutton->setUp">SWFbutton->setUp(%0);</dialog>

14945

14946

</function>

14947

14948

<description>Creates a new Button.</description>

14949

14950

<insert>SWFbutton();</insert>

14951

<dialog title="Insert SWFbutton">SWFbutton();</dialog>

14952

14953

</function>

14954

<function name="SWFDisplayItem->addColor">

14955

<description>Adds the given color to this item's color transform.</description>

14956

14957

<param name="green" required="0" vallist="0" default="" type="int">green</param>

14958

14959

14960

14961

<insert>SWFDisplayItem->addColor([int red] [,int green] [,int blue] [,int a]);</insert>

14962

<dialog title="Insert SWFDisplayItem->addColor">SWFDisplayItem->addColor(%0, %1, %2, %3);</dialog>

14963

14964

</function>

14965

14966

<description>Moves object in relative coordinates.</description>

14967

14968

14969

14970

<insert>SWFDisplayItem->move(int dx, int dy);</insert>

14971

<dialog title="Insert SWFDisplayItem->move">SWFDisplayItem->move(%0, %1);</dialog>

14972

14973

</function>

14974

<function name="SWFDisplayItem->moveTo">

14975

<description>Moves object in global coordinates.</description>

14976

14977

14978

14979

<insert>SWFDisplayItem->moveTo(int x, int y);</insert>

14980

<dialog title="Insert SWFDisplayItem->moveTo">SWFDisplayItem->moveTo(%0, %1);</dialog>

14981

14982

</function>

14983

<function name="SWFDisplayItem->multColor">

14984

<description>Multiplies the item's color transform.</description>

14985

14986

<param name="green" required="0" vallist="0" default="" type="int">green</param>

14987

14988

14989

14990

<insert>SWFDisplayItem->multColor([int red] [,int green] [,int blue] [,int a]);</insert>

14991

<dialog title="Insert SWFDisplayItem->multColor">SWFDisplayItem->multColor(%0, %1, %2, %3);</dialog>

14992

14993

</function>

14994

<function name="SWFDisplayItem->remove">

14995

<description>Removes the object from the movie</description>

14996

14997

<insert>SWFDisplayItem->remove();</insert>

14998

<dialog title="Insert SWFDisplayItem->remove">SWFDisplayItem->remove();</dialog>

14999

15000

</function>

15001

<function name="SWFDisplayItem->Rotate">

15002

<description>Rotates in relative coordinates.</description>

15003

<param name="ddegrees" required="1" vallist="0" default="" type="float">ddegrees</param>

15004

15005

<insert>SWFDisplayItem->Rotate(float ddegrees);</insert>

15006

<dialog title="Insert SWFDisplayItem->Rotate">SWFDisplayItem->Rotate(%0);</dialog>

15007

15008

</function>

15009

<function name="SWFDisplayItem->rotateTo">

15010

<description>Rotates the object in global coordinates.</description>

15011

<param name="degrees" required="1" vallist="0" default="" type="float">degrees</param>

15012

15013

<insert>SWFDisplayItem->rotateTo(float degrees);</insert>

15014

<dialog title="Insert SWFDisplayItem->rotateTo">SWFDisplayItem->rotateTo(%0);</dialog>

15015

15016

</function>

15017

<function name="SWFDisplayItem->scale">

15018

<description>Scales the object in relative coordinates.</description>

15019

15020

15021

15022

<insert>SWFDisplayItem->scale(int dx, int dy);</insert>

15023

<dialog title="Insert SWFDisplayItem->scale">SWFDisplayItem->scale(%0, %1);</dialog>

15024

15025

</function>

15026

<function name="SWFDisplayItem->scaleTo">

15027

<description>Scales the object in global coordinates.</description>

15028

15029

15030

15031

<insert>SWFDisplayItem->scaleTo(int x, int y);</insert>

15032

<dialog title="Insert SWFDisplayItem->scaleTo">SWFDisplayItem->scaleTo(%0, %1);</dialog>

15033

15034

</function>

15035

<function name="SWFDisplayItem->setDepth">

15036

<description>Sets z-order</description>

15037

<param name="depth" required="1" vallist="0" default="" type="float">depth</param>

15038

15039

<insert>SWFDisplayItem->setDepth(float depth);</insert>

15040

<dialog title="Insert SWFDisplayItem->setDepth">SWFDisplayItem->setDepth(%0);</dialog>

15041

15042

</function>

15043

<function name="SWFDisplayItem->setName">

15044

<description>Sets the object's name</description>

15045

15046

15047

<insert>SWFDisplayItem->setName(string name);</insert>

15048

<dialog title="Insert SWFDisplayItem->setName">SWFDisplayItem->setName(%0);</dialog>

15049

15050

</function>

15051

<function name="SWFDisplayItem->setRatio">

15052

<description>Sets the object's ratio.</description>

15053

<param name="ratio" required="1" vallist="0" default="" type="float">ratio</param>

15054

15055

<insert>SWFDisplayItem->setRatio(float ratio);</insert>

15056

<dialog title="Insert SWFDisplayItem->setRatio">SWFDisplayItem->setRatio(%0);</dialog>

15057

15058

</function>

15059

<function name="SWFDisplayItem->skewX">

15060

15061

<param name="ddegrees" required="1" vallist="0" default="" type="float">ddegrees</param>

15062

15063

<insert>SWFDisplayItem->skewX(float ddegrees);</insert>

15064

<dialog title="Insert SWFDisplayItem->skewX">SWFDisplayItem->skewX(%0);</dialog>

15065

15066

</function>

15067

<function name="SWFDisplayItem->skewXTo">

15068

15069

<param name="degrees" required="1" vallist="0" default="" type="float">degrees</param>

15070

15071

<insert>SWFDisplayItem->skewXTo(float degrees);</insert>

15072

<dialog title="Insert SWFDisplayItem->skewXTo">SWFDisplayItem->skewXTo(%0);</dialog>

15073

15074

</function>

15075

<function name="SWFDisplayItem->skewY">

15076

15077

<param name="ddegrees" required="1" vallist="0" default="" type="float">ddegrees</param>

15078

15079

<insert>SWFDisplayItem->skewY(float ddegrees);</insert>

15080

<dialog title="Insert SWFDisplayItem->skewY">SWFDisplayItem->skewY(%0);</dialog>

15081

15082

</function>

15083

<function name="SWFDisplayItem->skewYTo">

15084

15085

<param name="degrees" required="1" vallist="0" default="" type="float">degrees</param>

15086

15087

<insert>SWFDisplayItem->skewYTo(float degrees);</insert>

15088

<dialog title="Insert SWFDisplayItem->skewYTo">SWFDisplayItem->skewYTo(%0);</dialog>

15089

15090

</function>

15091

15092

<description>Creates a new displayitem object.</description>

15093

15094

<insert>SWFDisplayItem();</insert>

15095

<dialog title="Insert SWFDisplayItem">SWFDisplayItem();</dialog>

15096

15097

</function>

15098

<function name="SWFFill->moveTo">

15099

<description>Moves fill origin</description>

15100

15101

15102

15103

<insert>SWFFill->moveTo(int x, int y);</insert>

15104

<dialog title="Insert SWFFill->moveTo">SWFFill->moveTo(%0, %1);</dialog>

15105

15106

</function>

15107

<function name="SWFFill->rotateTo">

15108

<description>Sets fill's rotation</description>

15109

<param name="degrees" required="1" vallist="0" default="" type="float">degrees</param>

15110

15111

<insert>SWFFill->rotateTo(float degrees);</insert>

15112

<dialog title="Insert SWFFill->rotateTo">SWFFill->rotateTo(%0);</dialog>

15113

15114

</function>

15115

<function name="SWFFill->scaleTo">

15116

<description>Sets fill's scale</description>

15117

15118

15119

15120

<insert>SWFFill->scaleTo(int x, int y);</insert>

15121

<dialog title="Insert SWFFill->scaleTo">SWFFill->scaleTo(%0, %1);</dialog>

15122

15123

</function>

15124

<function name="SWFFill->skewXTo">

15125

15126

15127

15128

<insert>SWFFill->skewXTo(float x);</insert>

15129

<dialog title="Insert SWFFill->skewXTo">SWFFill->skewXTo(%0);</dialog>

15130

15131

</function>

15132

<function name="SWFFill->skewYTo">

15133

15134

15135

15136

<insert>SWFFill->skewYTo(float y);</insert>

15137

<dialog title="Insert SWFFill->skewYTo">SWFFill->skewYTo(%0);</dialog>

15138

15139

</function>

15140

15141

<description>Loads SWFFill object</description>

15142

15143

<insert>SWFFill();</insert>

15144

<dialog title="Insert SWFFill">SWFFill();</dialog>

15145

15146

</function>

15147

<function name="swffont->getwidth">

15148

<description>Returns the string's width</description>

15149

<param name="string" required="1" vallist="0" default="" type="string">string</param>

15150

15151

<insert>swffont->getwidth(string string);</insert>

15152

<dialog title="Insert swffont->getwidth">swffont->getwidth(%0);</dialog>

15153

15154

</function>

15155

15156

<description>Loads a font definition</description>

15157

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

15158

15159

<insert>SWFFont(string filename);</insert>

15160

<dialog title="Insert SWFFont">SWFFont(%0);</dialog>

15161

15162

</function>

15163

<function name="SWFGradient->addEntry">

15164

<description>Adds an entry to the gradient list.</description>

15165

<param name="ratio" required="1" vallist="0" default="" type="float">ratio</param>

15166

15167

<param name="green" required="1" vallist="0" default="" type="int">green</param>

15168

15169

15170

15171

<insert>SWFGradient->addEntry(float ratio, int red, int green, int blue [,int a]);</insert>

15172

<dialog title="Insert SWFGradient->addEntry">SWFGradient->addEntry(%0, %1, %2, %3, %4);</dialog>

15173

15174

</function>

15175

15176

<description>Creates a gradient object</description>

15177

15178

<insert>SWFGradient();</insert>

15179

<dialog title="Insert SWFGradient">SWFGradient();</dialog>

15180

15181

</function>

15182

<function name="SWFMorph->getshape1">

15183

<description>Gets a handle to the starting shape</description>

15184

<return type="mixed">mixed</return>

15185

<insert>SWFMorph->getshape1();</insert>

15186

<dialog title="Insert SWFMorph->getshape1">SWFMorph->getshape1();</dialog>

15187

15188

</function>

15189

<function name="SWFMorph->getshape2">

15190

<description>Gets a handle to the ending shape</description>

15191

<return type="mixed">mixed</return>

15192

<insert>SWFMorph->getshape2();</insert>

15193

<dialog title="Insert SWFMorph->getshape2">SWFMorph->getshape2();</dialog>

15194

15195

</function>

15196

15197

<description>Creates a new SWFMorph object.</description>

15198

15199

<insert>SWFMorph();</insert>

15200

<dialog title="Insert SWFMorph">SWFMorph();</dialog>

15201

15202

</function>

15203

15204

<description>Adds any type of data to a movie.</description>

15205

<param name="instance" required="1" vallist="0" default="" type="ressource">instance</param>

15206

15207

<insert>SWFMovie->add(ressource instance);</insert>

15208

<dialog title="Insert SWFMovie->add">SWFMovie->add(%0);</dialog>

15209

15210

</function>

15211

<function name="SWFMovie->nextframe">

15212

<description>Moves to the next frame of the animation.</description>

15213

15214

<insert>SWFMovie->nextframe();</insert>

15215

<dialog title="Insert SWFMovie->nextframe">SWFMovie->nextframe();</dialog>

15216

15217

</function>

15218

<function name="SWFMovie->output">

15219

<description>Dumps your lovingly prepared movie out.</description>

15220

15221

<insert>SWFMovie->output();</insert>

15222

<dialog title="Insert SWFMovie->output">SWFMovie->output();</dialog>

15223

15224

</function>

15225

<function name="swfmovie->remove">

15226

<description>Removes the object instance from the display list.</description>

15227

<param name="instance" required="1" vallist="0" default="" type="resource">instance</param>

15228

15229

<insert>swfmovie->remove(resource instance);</insert>

15230

<dialog title="Insert swfmovie->remove">swfmovie->remove(%0);</dialog>

15231

15232

</function>

15233

15234

<description>Saves your movie in a file.</description>

15235

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

15236

15237

<insert>SWFMovie->save(string filename);</insert>

15238

<dialog title="Insert SWFMovie->save">SWFMovie->save(%0);</dialog>

15239

15240

</function>

15241

<function name="SWFMovie->setbackground">

15242

<description>Sets the background color.</description>

15243

15244

<param name="green" required="1" vallist="0" default="" type="int">green</param>

15245

15246

15247

<insert>SWFMovie->setbackground(int red, int green, int blue);</insert>

15248

<dialog title="Insert SWFMovie->setbackground">SWFMovie->setbackground(%0, %1, %2);</dialog>

15249

15250

</function>

15251

<function name="SWFMovie->setdimension">

15252

<description>Sets the movie's width and height.</description>

15253

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15254

<param name="height" required="1" vallist="0" default="" type="int">height</param>

15255

15256

<insert>SWFMovie->setdimension(int width, int height);</insert>

15257

<dialog title="Insert SWFMovie->setdimension">SWFMovie->setdimension(%0, %1);</dialog>

15258

15259

</function>

15260

<function name="SWFMovie->setframes">

15261

<description>Sets the total number of frames in the animation.</description>

15262

<param name="numberofframes" required="1" vallist="0" default="" type="string">numberofframes</param>

15263

15264

<insert>SWFMovie->setframes(string numberofframes);</insert>

15265

<dialog title="Insert SWFMovie->setframes">SWFMovie->setframes(%0);</dialog>

15266

15267

</function>

15268

<function name="SWFMovie->setrate">

15269

<description>Sets the animation's frame rate.</description>

15270

15271

15272

<insert>SWFMovie->setrate(int rate);</insert>

15273

<dialog title="Insert SWFMovie->setrate">SWFMovie->setrate(%0);</dialog>

15274

15275

</function>

15276

<function name="SWFMovie->streammp3">

15277

<description>Streams a MP3 file.</description>

15278

<param name="mp3FileName" required="1" vallist="0" default="" type="string">mp3FileName</param>

15279

15280

<insert>SWFMovie->streammp3(string mp3FileName);</insert>

15281

<dialog title="Insert SWFMovie->streammp3">SWFMovie->streammp3(%0);</dialog>

15282

15283

</function>

15284

15285

<description>Creates a new movie object, representing an SWF version 4 movie.</description>

15286

15287

<insert>SWFMovie();</insert>

15288

<dialog title="Insert SWFMovie">SWFMovie();</dialog>

15289

15290

</function>

15291

<function name="SWFShape->addFill">

15292

<description>Adds a solid fill to the shape.</description>

15293

15294

<param name="green" required="1" vallist="0" default="" type="int">green</param>

15295

15296

15297

15298

<insert>SWFShape->addFill(int red, int green, int blue [,int a]);</insert>

15299

<dialog title="Insert SWFShape->addFill">SWFShape->addFill(%0, %1, %2, %3);</dialog>

15300

15301

</function>

15302

<function name="SWFShape->drawCurve">

15303

<description>Draws a curve (relative).</description>

15304

<param name="controldx" required="1" vallist="0" default="" type="int">controldx</param>

15305

<param name="controldy" required="1" vallist="0" default="" type="int">controldy</param>

15306

<param name="anchordx" required="1" vallist="0" default="" type="int">anchordx</param>

15307

<param name="anchordy" required="1" vallist="0" default="" type="int">anchordy</param>

15308

15309

<insert>SWFShape->drawCurve(int controldx, int controldy, int anchordx, int anchordy);</insert>

15310

<dialog title="Insert SWFShape->drawCurve">SWFShape->drawCurve(%0, %1, %2, %3);</dialog>

15311

15312

</function>

15313

<function name="SWFShape->drawCurveTo">

15314

<description>Draws a curve.</description>

15315

<param name="controlx" required="1" vallist="0" default="" type="int">controlx</param>

15316

<param name="controly" required="1" vallist="0" default="" type="int">controly</param>

15317

<param name="anchorx" required="1" vallist="0" default="" type="int">anchorx</param>

15318

<param name="anchory" required="1" vallist="0" default="" type="int">anchory</param>

15319

15320

<insert>SWFShape->drawCurveTo(int controlx, int controly, int anchorx, int anchory);</insert>

15321

<dialog title="Insert SWFShape->drawCurveTo">SWFShape->drawCurveTo(%0, %1, %2, %3);</dialog>

15322

15323

</function>

15324

<function name="SWFShape->drawLine">

15325

<description>Draws a line (relative).</description>

15326

15327

15328

15329

<insert>SWFShape->drawLine(int dx, int dy);</insert>

15330

<dialog title="Insert SWFShape->drawLine">SWFShape->drawLine(%0, %1);</dialog>

15331

15332

</function>

15333

<function name="SWFShape->drawLineTo">

15334

<description>Draws a line.</description>

15335

15336

15337

15338

<insert>SWFShape->drawLineTo(int x, int y);</insert>

15339

<dialog title="Insert SWFShape->drawLineTo">SWFShape->drawLineTo(%0, %1);</dialog>

15340

15341

</function>

15342

<function name="SWFShape->movePen">

15343

<description>Moves the shape's pen (relative).</description>

15344

15345

15346

15347

<insert>SWFShape->movePen(int dx, int dy);</insert>

15348

<dialog title="Insert SWFShape->movePen">SWFShape->movePen(%0, %1);</dialog>

15349

15350

</function>

15351

<function name="SWFShape->movePenTo">

15352

<description>Moves the shape's pen.</description>

15353

15354

15355

15356

<insert>SWFShape->movePenTo(int x, int y);</insert>

15357

<dialog title="Insert SWFShape->movePenTo">SWFShape->movePenTo(%0, %1);</dialog>

15358

15359

</function>

15360

<function name="SWFShape->setLeftFill">

15361

<description>Sets left rasterizing color.</description>

15362

15363

15364

<insert>SWFShape->setLeftFill(swfgradient fill);</insert>

15365

<dialog title="Insert SWFShape->setLeftFill">SWFShape->setLeftFill(%0);</dialog>

15366

15367

</function>

15368

<function name="SWFShape->setLine">

15369

<description>Sets the shape's line style.</description>

15370

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15371

15372

<param name="green" required="0" vallist="0" default="" type="int">green</param>

15373

15374

15375

15376

<insert>SWFShape->setLine(int width [,int red] [,int green] [,int blue] [,int a]);</insert>

15377

<dialog title="Insert SWFShape->setLine">SWFShape->setLine(%0, %1, %2, %3, %4);</dialog>

15378

15379

</function>

15380

<function name="SWFShape->setRightFill">

15381

<description>Sets right rasterizing color.</description>

15382

15383

15384

<insert>SWFShape->setRightFill(swfgradient fill);</insert>

15385

<dialog title="Insert SWFShape->setRightFill">SWFShape->setRightFill(%0);</dialog>

15386

15387

</function>

15388

15389

<description>Creates a new shape object.</description>

15390

15391

<insert>SWFShape();</insert>

15392

<dialog title="Insert SWFShape">SWFShape();</dialog>

15393

15394

</function>

15395

15396

<description>Adds an object to a sprite</description>

15397

<param name="object" required="1" vallist="0" default="" type="resource">object</param>

15398

15399

<insert>swfsprite->add(resource object);</insert>

15400

<dialog title="Insert swfsprite->add">swfsprite->add(%0);</dialog>

15401

15402

</function>

15403

<function name="SWFSprite->nextframe">

15404

<description>Moves to the next frame of the animation.</description>

15405

15406

<insert>SWFSprite->nextframe();</insert>

15407

<dialog title="Insert SWFSprite->nextframe">SWFSprite->nextframe();</dialog>

15408

15409

</function>

15410

<function name="SWFSprite->remove">

15411

<description>Removes an object to a sprite</description>

15412

<param name="object" required="1" vallist="0" default="" type="ressource">object</param>

15413

15414

<insert>SWFSprite->remove(ressource object);</insert>

15415

<dialog title="Insert SWFSprite->remove">SWFSprite->remove(%0);</dialog>

15416

15417

</function>

15418

<function name="SWFSprite->setframes">

15419

<description>Sets the total number of frames in the animation.</description>

15420

<param name="numberofframes" required="1" vallist="0" default="" type="int">numberofframes</param>

15421

15422

<insert>SWFSprite->setframes(int numberofframes);</insert>

15423

<dialog title="Insert SWFSprite->setframes">SWFSprite->setframes(%0);</dialog>

15424

15425

</function>

15426

15427

<description>Creates a movie clip (a sprite)</description>

15428

15429

<insert>SWFSprite();</insert>

15430

<dialog title="Insert SWFSprite">SWFSprite();</dialog>

15431

15432

</function>

15433

<function name="SWFText->addString">

15434

<description>Draws a string</description>

15435

<param name="string" required="1" vallist="0" default="" type="string">string</param>

15436

15437

<insert>SWFText->addString(string string);</insert>

15438

<dialog title="Insert SWFText->addString">SWFText->addString(%0);</dialog>

15439

15440

</function>

15441

<function name="SWFText->getWidth">

15442

<description>Computes string's width</description>

15443

<param name="string" required="1" vallist="0" default="" type="string">string</param>

15444

15445

<insert>SWFText->getWidth(string string);</insert>

15446

<dialog title="Insert SWFText->getWidth">SWFText->getWidth(%0);</dialog>

15447

15448

</function>

15449

<function name="SWFText->moveTo">

15450

<description>Moves the pen</description>

15451

15452

15453

15454

<insert>SWFText->moveTo(int x, int y);</insert>

15455

<dialog title="Insert SWFText->moveTo">SWFText->moveTo(%0, %1);</dialog>

15456

15457

</function>

15458

<function name="SWFText->setColor">

15459

<description>Sets the current font color</description>

15460

15461

<param name="green" required="1" vallist="0" default="" type="int">green</param>

15462

15463

15464

15465

<insert>SWFText->setColor(int red, int green, int blue [,int a]);</insert>

15466

<dialog title="Insert SWFText->setColor">SWFText->setColor(%0, %1, %2, %3);</dialog>

15467

15468

</function>

15469

<function name="SWFText->setFont">

15470

<description>Sets the current font</description>

15471

15472

15473

<insert>SWFText->setFont(string font);</insert>

15474

<dialog title="Insert SWFText->setFont">SWFText->setFont(%0);</dialog>

15475

15476

</function>

15477

<function name="SWFText->setHeight">

15478

<description>Sets the current font height</description>

15479

<param name="height" required="1" vallist="0" default="" type="int">height</param>

15480

15481

<insert>SWFText->setHeight(int height);</insert>

15482

<dialog title="Insert SWFText->setHeight">SWFText->setHeight(%0);</dialog>

15483

15484

</function>

15485

<function name="SWFText->setSpacing">

15486

<description>Sets the current font spacing</description>

15487

<param name="spacing" required="1" vallist="0" default="" type="float">spacing</param>

15488

15489

<insert>SWFText->setSpacing(float spacing);</insert>

15490

<dialog title="Insert SWFText->setSpacing">SWFText->setSpacing(%0);</dialog>

15491

15492

</function>

15493

15494

<description>Creates a new SWFText object.</description>

15495

15496

<insert>SWFText();</insert>

15497

<dialog title="Insert SWFText">SWFText();</dialog>

15498

15499

</function>

15500

<function name="SWFTextField->addstring">

15501

<description>Concatenates the given string to the text field</description>

15502

<param name="string" required="1" vallist="0" default="" type="string">string</param>

15503

15504

<insert>SWFTextField->addstring(string string);</insert>

15505

<dialog title="Insert SWFTextField->addstring">SWFTextField->addstring(%0);</dialog>

15506

15507

</function>

15508

<function name="SWFTextField->align">

15509

<description>Sets the text field alignment</description>

15510

<param name="alignement" required="1" vallist="0" default="" type="int">alignement</param>

15511

15512

<insert>SWFTextField->align(int alignement);</insert>

15513

<dialog title="Insert SWFTextField->align">SWFTextField->align(%0);</dialog>

15514

15515

</function>

15516

<function name="SWFTextField->setbounds">

15517

<description>Sets the text field width and height</description>

15518

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15519

<param name="height" required="1" vallist="0" default="" type="int">height</param>

15520

15521

<insert>SWFTextField->setbounds(int width, int height);</insert>

15522

<dialog title="Insert SWFTextField->setbounds">SWFTextField->setbounds(%0, %1);</dialog>

15523

15524

</function>

15525

<function name="SWFTextField->setcolor">

15526

<description>Sets the color of the text field. </description>

15527

15528

<param name="green" required="1" vallist="0" default="" type="int">green</param>

15529

15530

15531

15532

<insert>SWFTextField->setcolor(int red, int green, int blue [,int a]);</insert>

15533

<dialog title="Insert SWFTextField->setcolor">SWFTextField->setcolor(%0, %1, %2, %3);</dialog>

15534

15535

</function>

15536

<function name="SWFTextField->setFont">

15537

<description>Sets the text field font</description>

15538

15539

15540

<insert>SWFTextField->setFont(string font);</insert>

15541

<dialog title="Insert SWFTextField->setFont">SWFTextField->setFont(%0);</dialog>

15542

15543

</function>

15544

<function name="SWFTextField->setHeight">

15545

<description>Sets the font height of this text field font.</description>

15546

<param name="height" required="1" vallist="0" default="" type="int">height</param>

15547

15548

<insert>SWFTextField->setHeight(int height);</insert>

15549

<dialog title="Insert SWFTextField->setHeight">SWFTextField->setHeight(%0);</dialog>

15550

15551

</function>

15552

<function name="SWFTextField->setindentation">

15553

<description>Sets the indentation of the first line.</description>

15554

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15555

15556

<insert>SWFTextField->setindentation(int width);</insert>

15557

<dialog title="Insert SWFTextField->setindentation">SWFTextField->setindentation(%0);</dialog>

15558

15559

</function>

15560

<function name="SWFTextField->setLeftMargin">

15561

<description>Sets the left margin width of the text field.</description>

15562

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15563

15564

<insert>SWFTextField->setLeftMargin(int width);</insert>

15565

<dialog title="Insert SWFTextField->setLeftMargin">SWFTextField->setLeftMargin(%0);</dialog>

15566

15567

</function>

15568

<function name="SWFTextField->setLineSpacing">

15569

<description>Sets the line spacing of the text field.</description>

15570

<param name="height" required="1" vallist="0" default="" type="int">height</param>

15571

15572

<insert>SWFTextField->setLineSpacing(int height);</insert>

15573

<dialog title="Insert SWFTextField->setLineSpacing">SWFTextField->setLineSpacing(%0);</dialog>

15574

15575

</function>

15576

<function name="SWFTextField->setMargins">

15577

<description>Sets the margins width of the text field.</description>

15578

15579

<param name="right" required="1" vallist="0" default="" type="int">right</param>

15580

15581

<insert>SWFTextField->setMargins(int left, int right);</insert>

15582

<dialog title="Insert SWFTextField->setMargins">SWFTextField->setMargins(%0, %1);</dialog>

15583

15584

</function>

15585

<function name="SWFTextField->setname">

15586

<description>Sets the variable name</description>

15587

15588

15589

<insert>SWFTextField->setname(string name);</insert>

15590

<dialog title="Insert SWFTextField->setname">SWFTextField->setname(%0);</dialog>

15591

15592

</function>

15593

<function name="SWFTextField->setrightMargin">

15594

<description>Sets the right margin width of the text field.</description>

15595

<param name="width" required="1" vallist="0" default="" type="int">width</param>

15596

15597

<insert>SWFTextField->setrightMargin(int width);</insert>

15598

<dialog title="Insert SWFTextField->setrightMargin">SWFTextField->setrightMargin(%0);</dialog>

15599

15600

</function>

15601

15602

<description>Creates a text field object</description>

15603

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

15604

15605

<insert>SWFTextField([int flags]);</insert>

15606

<dialog title="Insert SWFTextField">SWFTextField(%0);</dialog>

15607

15608

</function>

15609

</group>

15610

15611

15612

<description>Returns </description>

15613

15614

<insert>connection_aborted();</insert>

15615

<dialog title="Insert connection_aborted">connection_aborted();</dialog>

15616

15617

</function>

15618

15619

<description>Returns connection status bitfield</description>

15620

15621

<insert>connection_status();</insert>

15622

<dialog title="Insert connection_status">connection_status();</dialog>

15623

15624

</function>

15625

15626

<description>Return </description>

15627

15628

<insert>connection_timeout();</insert>

15629

<dialog title="Insert connection_timeout">connection_timeout();</dialog>

15630

15631

</function>

15632

15633

<description>Returns the value of a constant</description>

15634

15635

<return type="mixed">mixed</return>

15636

<insert>constant(string name);</insert>

15637

<dialog title="Insert constant">constant(%0);</dialog>

15638

15639

</function>

15640

15641

<description>Defines a named constant.</description>

15642

15643

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

15644

<param name="case_insensitive" required="0" vallist="0" default="" type="bool">case_insensitive</param>

15645

15646

<insert>define(string name, mixed value [,bool case_insensitive]);</insert>

15647

<dialog title="Insert define">define(%0, %1, %2);</dialog>

15648

15649

</function>

15650

15651

15652

Checks whether a given named constant exists

15653

</description>

15654

15655

15656

<insert>defined(string name);</insert>

15657

<dialog title="Insert defined">defined(%0);</dialog>

15658

15659

</function>

15660

15661

<description>Evaluate a string as PHP code</description>

15662

15663

<return type="mixed">mixed</return>

15664

<insert>eval(string code_str);</insert>

15665

15666

15667

</function>

15668

15669

<description>Output a message and terminate the current script</description>

15670

<param name="status" required="0" vallist="0" default="" type="string">status</param>

15671

15672

<insert>exit([string status]);</insert>

15673

15674

15675

</function>

15676

15677

15678

Tells what the user's browser is capable of

15679

</description>

15680

<param name="user_agent" required="0" vallist="0" default="" type="string">user_agent</param>

15681

<return type="object">object</return>

15682

<insert>get_browser([string user_agent]);</insert>

15683

<dialog title="Insert get_browser">get_browser(%0);</dialog>

15684

15685

</function>

15686

15687

<description>Syntax highlighting of a file</description>

15688

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

15689

<param name="return" required="0" vallist="0" default="" type="bool">return</param>

15690

<return type="mixed">mixed</return>

15691

<insert>highlight_file(string filename [,bool return]);</insert>

15692

<dialog title="Insert highlight_file">highlight_file(%0, %1);</dialog>

15693

15694

</function>

15695

15696

<description>Syntax highlighting of a string</description>

15697

15698

<param name="return" required="0" vallist="0" default="" type="bool">return</param>

15699

<return type="mixed">mixed</return>

15700

<insert>highlight_string(string str [,bool return]);</insert>

15701

<dialog title="Insert highlight_string">highlight_string(%0, %1);</dialog>

15702

15703

</function>

15704

15705

15706

Set whether a client disconnect should abort script execution

15707

</description>

15708

<param name="setting" required="0" vallist="0" default="" type="int">setting</param>

15709

15710

<insert>ignore_user_abort([int setting]);</insert>

15711

<dialog title="Insert ignore_user_abort">ignore_user_abort(%0);</dialog>

15712

15713

</function>

15714

15715

<description>Pack data into binary string.</description>

15716

<param name="format" required="1" vallist="0" default="" type="string">format</param>

15717

15718

<return type="string">string</return>

15719

<insert>pack(string format [,mixed args]);</insert>

15720

15721

15722

</function>

15723

15724

<description>Delay execution</description>

15725

<param name="seconds" required="1" vallist="0" default="" type="int">seconds</param>

15726

15727

<insert>sleep(int seconds);</insert>

15728

<dialog title="Insert sleep">sleep(%0);</dialog>

15729

15730

</function>

15731

15732

<description>Generate a unique ID</description>

15733

<param name="prefix" required="1" vallist="0" default="" type="string">prefix</param>

15734

15735

<return type="string">string</return>

15736

<insert>uniqid(string prefix [,bool lcg]);</insert>

15737

<dialog title="Insert uniqid">uniqid(%0, %1);</dialog>

15738

15739

</function>

15740

15741

<description>Unpack data from binary string</description>

15742

<param name="format" required="1" vallist="0" default="" type="string">format</param>

15743

15744

<return type="array">array</return>

15745

<insert>unpack(string format, string data);</insert>

15746

<dialog title="Insert unpack">unpack(%0, %1);</dialog>

15747

15748

</function>

15749

15750

<description>Delay execution in microseconds</description>

15751

<param name="micro_seconds" required="1" vallist="0" default="" type="int">micro_seconds</param>

15752

15753

<insert>usleep(int micro_seconds);</insert>

15754

<dialog title="Insert usleep">usleep(%0);</dialog>

15755

15756

</function>

15757

</group>

15758

15759

15760

<description>Add various search limits</description>

15761

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15762

15763

15764

15765

<insert>udm_add_search_limit(int agent, int var, string val);</insert>

15766

<dialog title="Insert udm_add_search_limit">udm_add_search_limit(%0, %1, %2);</dialog>

15767

15768

</function>

15769

15770

<description>Allocate mnoGoSearch session</description>

15771

<param name="dbaddr" required="1" vallist="0" default="" type="string">dbaddr</param>

15772

<param name="dbmode" required="0" vallist="0" default="" type="string">dbmode</param>

15773

15774

<insert>udm_alloc_agent(string dbaddr [,string dbmode]);</insert>

15775

<dialog title="Insert udm_alloc_agent">udm_alloc_agent(%0, %1);</dialog>

15776

15777

</function>

15778

15779

<description>Get mnoGoSearch API version.</description>

15780

15781

<insert>udm_api_version();</insert>

15782

<dialog title="Insert udm_api_version">udm_api_version();</dialog>

15783

15784

</function>

15785

15786

<description>Get all the categories on the same level with the current one.</description>

15787

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15788

<param name="category" required="1" vallist="0" default="" type="string">category</param>

15789

<return type="array">array</return>

15790

<insert>udm_cat_list(int agent, string category);</insert>

15791

15792

15793

</function>

15794

15795

<description>Get the path to the current category.</description>

15796

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15797

<param name="category" required="1" vallist="0" default="" type="string">category</param>

15798

<return type="array">array</return>

15799

<insert>udm_cat_path(int agent, string category);</insert>

15800

15801

15802

</function>

15803

15804

15805

Check if the given charset is known to mnogosearch

15806

</description>

15807

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15808

<param name="charset" required="1" vallist="0" default="" type="string">charset</param>

15809

15810

<insert>udm_check_charset(int agent, string charset);</insert>

15811

<dialog title="Insert udm_check_charset">udm_check_charset(%0, %1);</dialog>

15812

15813

</function>

15814

15815

15816

Check connection to stored

15817

</description>

15818

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15819

15820

15821

15822

<insert>udm_check_stored(int agent, int link, string doc_id);</insert>

15823

<dialog title="Insert udm_check_stored">udm_check_stored(%0, %1, %2);</dialog>

15824

15825

</function>

15826

15827

<description>Clear all mnoGoSearch search restrictions</description>

15828

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15829

15830

<insert>udm_clear_search_limits(int agent);</insert>

15831

<dialog title="Insert udm_clear_search_limits">udm_clear_search_limits(%0);</dialog>

15832

15833

</function>

15834

15835

15836

Close connection to stored

15837

</description>

15838

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15839

15840

15841

<insert>udm_close_stored(int agent, int link);</insert>

15842

<dialog title="Insert udm_close_stored">udm_close_stored(%0, %1);</dialog>

15843

15844

</function>

15845

15846

15847

Return CRC32 checksum of gived string

15848

</description>

15849

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15850

15851

15852

<insert>udm_crc32(int agent, string str);</insert>

15853

15854

15855

</function>

15856

15857

<description>Get mnoGoSearch error number</description>

15858

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15859

15860

<insert>udm_errno(int agent);</insert>

15861

<dialog title="Insert udm_errno">udm_errno(%0);</dialog>

15862

15863

</function>

15864

15865

<description>Get mnoGoSearch error message</description>

15866

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15867

<return type="string">string</return>

15868

<insert>udm_error(int agent);</insert>

15869

<dialog title="Insert udm_error">udm_error(%0);</dialog>

15870

15871

</function>

15872

15873

<description>Perform search</description>

15874

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15875

<param name="query" required="1" vallist="0" default="" type="string">query</param>

15876

15877

<insert>udm_find(int agent, string query);</insert>

15878

15879

15880

</function>

15881

15882

<description>Free mnoGoSearch session</description>

15883

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15884

15885

<insert>udm_free_agent(int agent);</insert>

15886

<dialog title="Insert udm_free_agent">udm_free_agent(%0);</dialog>

15887

15888

</function>

15889

15890

<description>Free memory allocated for ispell data</description>

15891

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15892

15893

<insert>udm_free_ispell_data(int agent);</insert>

15894

<dialog title="Insert udm_free_ispell_data">udm_free_ispell_data(%0);</dialog>

15895

15896

</function>

15897

15898

<description>Free mnoGoSearch result</description>

15899

15900

15901

15902

15903

15904

</function>

15905

15906

<description>Get total number of documents in database.</description>

15907

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15908

15909

<insert>udm_get_doc_count(int agent);</insert>

15910

<dialog title="Insert udm_get_doc_count">udm_get_doc_count(%0);</dialog>

15911

15912

</function>

15913

15914

<description>Fetch mnoGoSearch result field</description>

15915

15916

15917

<param name="field" required="1" vallist="0" default="" type="int">field</param>

15918

<return type="string">string</return>

15919

<insert>udm_get_res_field(int res, int row, int field);</insert>

15920

<dialog title="Insert udm_get_res_field">udm_get_res_field(%0, %1, %2);</dialog>

15921

15922

</function>

15923

15924

<description>Get mnoGoSearch result parameters</description>

15925

15926

<param name="param" required="1" vallist="0" default="" type="int">param</param>

15927

<return type="string">string</return>

15928

<insert>udm_get_res_param(int res, int param);</insert>

15929

<dialog title="Insert udm_get_res_param">udm_get_res_param(%0, %1);</dialog>

15930

15931

</function>

15932

15933

<description>Load ispell data</description>

15934

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15935

15936

15937

15938

15939

15940

<insert>udm_load_ispell_data(int agent, int var, string val1, string val2, int flag);</insert>

15941

<dialog title="Insert udm_load_ispell_data">udm_load_ispell_data(%0, %1, %2, %3, %4);</dialog>

15942

15943

</function>

15944

15945

15946

Open connection to stored

15947

</description>

15948

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15949

<param name="storedaddr" required="1" vallist="0" default="" type="string">storedaddr</param>

15950

15951

<insert>udm_open_stored(int agent, string storedaddr);</insert>

15952

<dialog title="Insert udm_open_stored">udm_open_stored(%0, %1);</dialog>

15953

15954

</function>

15955

15956

<description>Set mnoGoSearch agent session parameters</description>

15957

<param name="agent" required="1" vallist="0" default="" type="int">agent</param>

15958

15959

15960

15961

<insert>udm_set_agent_param(int agent, int var, string val);</insert>

15962

<dialog title="Insert udm_set_agent_param">udm_set_agent_param(%0, %1, %2);</dialog>

15963

15964

</function>

15965

</group>

15966

15967

15968

<description>Connect to msession server </description>

15969

15970

15971

15972

<insert>msession_connect(string host, string port);</insert>

15973

<dialog title="Insert msession_connect">msession_connect(%0, %1);</dialog>

15974

15975

</function>

15976

15977

<description>Get session count </description>

15978

15979

<insert>msession_count();</insert>

15980

<dialog title="Insert msession_count">msession_count();</dialog>

15981

15982

</function>

15983

15984

<description>Create a session </description>

15985

<param name="session" required="1" vallist="0" default="" type="string">session</param>

15986

15987

<insert>msession_create(string session);</insert>

15988

<dialog title="Insert msession_create">msession_create(%0);</dialog>

15989

15990

</function>

15991

15992

<description>Destroy a session </description>

15993

15994

15995

<insert>msession_destroy(string name);</insert>

15996

<dialog title="Insert msession_destroy">msession_destroy(%0);</dialog>

15997

15998

</function>

15999

16000

<description>Close connection to msession server </description>

16001

16002

<insert>msession_disconnect();</insert>

16003

<dialog title="Insert msession_disconnect">msession_disconnect();</dialog>

16004

16005

</function>

16006

16007

<description>Find value </description>

16008

16009

<param name="value" required="1" vallist="0" default="" type="string">value</param>

16010

<return type="array">array</return>

16011

<insert>msession_find(string name, string value);</insert>

16012

<dialog title="Insert msession_find">msession_find(%0, %1);</dialog>

16013

16014

</function>

16015

16016

<description>Get array of ... ? </description>

16017

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16018

<return type="array">array</return>

16019

<insert>msession_get_array(string session);</insert>

16020

<dialog title="Insert msession_get_array">msession_get_array(%0);</dialog>

16021

16022

</function>

16023

16024

<description>Get value from session </description>

16025

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16026

16027

<param name="value" required="1" vallist="0" default="" type="string">value</param>

16028

<return type="string">string</return>

16029

<insert>msession_get(string session, string name, string value);</insert>

16030

<dialog title="Insert msession_get">msession_get(%0, %1, %2);</dialog>

16031

16032

</function>

16033

16034

16035

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16036

<return type="string">string</return>

16037

<insert>msession_getdata(string session);</insert>

16038

<dialog title="Insert msession_getdata">msession_getdata(%0);</dialog>

16039

16040

</function>

16041

16042

<description>Increment value in session </description>

16043

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16044

16045

<return type="string">string</return>

16046

<insert>msession_inc(string session, string name);</insert>

16047

<dialog title="Insert msession_inc">msession_inc(%0, %1);</dialog>

16048

16049

</function>

16050

16051

16052

<return type="array">array</return>

16053

<insert>msession_list();</insert>

16054

<dialog title="Insert msession_list">msession_list();</dialog>

16055

16056

</function>

16057

16058

<description>List sessions with variable</description>

16059

16060

<return type="array">array</return>

16061

<insert>msession_listvar(string name);</insert>

16062

<dialog title="Insert msession_listvar">msession_listvar(%0);</dialog>

16063

16064

</function>

16065

16066

<description>Lock a session </description>

16067

16068

16069

<insert>msession_lock(string name);</insert>

16070

<dialog title="Insert msession_lock">msession_lock(%0);</dialog>

16071

16072

</function>

16073

16074

<description>Call an escape function within the msession personality plugin</description>

16075

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16076

16077

<param name="param" required="0" vallist="0" default="" type="string">param</param>

16078

<return type="string">string</return>

16079

<insert>msession_plugin(string session, string val [,string param]);</insert>

16080

<dialog title="Insert msession_plugin">msession_plugin(%0, %1, %2);</dialog>

16081

16082

</function>

16083

16084

<description>Get random string </description>

16085

<param name="param" required="1" vallist="0" default="" type="int">param</param>

16086

<return type="string">string</return>

16087

<insert>msession_randstr(int param);</insert>

16088

<dialog title="Insert msession_randstr">msession_randstr(%0);</dialog>

16089

16090

</function>

16091

16092

<description>Set array of ... </description>

16093

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16094

<param name="tuples" required="1" vallist="0" default="" type="array">tuples</param>

16095

16096

<insert>msession_set_array(string session, array tuples);</insert>

16097

<dialog title="Insert msession_set_array">msession_set_array(%0, %1);</dialog>

16098

16099

</function>

16100

16101

<description>Set value in session </description>

16102

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16103

16104

<param name="value" required="1" vallist="0" default="" type="string">value</param>

16105

16106

<insert>msession_set(string session, string name, string value);</insert>

16107

<dialog title="Insert msession_set">msession_set(%0, %1, %2);</dialog>

16108

16109

</function>

16110

16111

16112

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16113

<param name="value" required="1" vallist="0" default="" type="string">value</param>

16114

16115

<insert>msession_setdata(string session, string value);</insert>

16116

<dialog title="Insert msession_setdata">msession_setdata(%0, %1);</dialog>

16117

16118

</function>

16119

16120

<description>Set/get session timeout </description>

16121

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16122

<param name="param" required="0" vallist="0" default="" type="int">param</param>

16123

16124

<insert>msession_timeout(string session [,int param]);</insert>

16125

<dialog title="Insert msession_timeout">msession_timeout(%0, %1);</dialog>

16126

16127

</function>

16128

16129

16130

<param name="param" required="1" vallist="0" default="" type="int">param</param>

16131

<return type="string">string</return>

16132

<insert>msession_uniq(int param);</insert>

16133

<dialog title="Insert msession_uniq">msession_uniq(%0);</dialog>

16134

16135

</function>

16136

16137

<description>Unlock a session </description>

16138

<param name="session" required="1" vallist="0" default="" type="string">session</param>

16139

16140

16141

<insert>msession_unlock(string session, int key);</insert>

16142

<dialog title="Insert msession_unlock">msession_unlock(%0, %1);</dialog>

16143

16144

</function>

16145

</group>

16146

16147

16148

<description>Returns number of affected rows</description>

16149

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16150

16151

<insert>msql_affected_rows(int query_identifier);</insert>

16152

<dialog title="Insert msql_affected_rows">msql_affected_rows(%0);</dialog>

16153

16154

</function>

16155

16156

<description>Close mSQL connection</description>

16157

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

16158

16159

<insert>msql_close(int link_identifier);</insert>

16160

<dialog title="Insert msql_close">msql_close(%0);</dialog>

16161

16162

</function>

16163

16164

<description>Open mSQL connection</description>

16165

<param name="

16166

hostname

16167

" required="0" vallist="0" default="" type="string">

16168

hostname

16169

</param>

16170

<param name="

16171

server

16172

" required="0" vallist="0" default="" type="string">

16173

server

16174

</param>

16175

<param name="

16176

username

16177

" required="0" vallist="0" default="" type="string">

16178

username

16179

</param>

16180

<param name="

16181

password

16182

" required="0" vallist="0" default="" type="string">

16183

password

16184

</param>

16185

16186

<insert>msql_connect([string

16187

hostname

16188

] [,string

16189

server

16190

] [,string

16191

username

16192

] [,string

16193

password

16194

]);</insert>

16195

<dialog title="Insert msql_connect">msql_connect(%0, %1, %2, %3);</dialog>

16196

16197

</function>

16198

16199

<description>Create mSQL database</description>

16200

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

16201

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16202

16203

<insert>msql_create_db(string database_name [,int link_identifier]);</insert>

16204

<dialog title="Insert msql_create_db">msql_create_db(%0, %1);</dialog>

16205

16206

</function>

16207

16208

<description>Create mSQL database</description>

16209

<param name="database name" required="1" vallist="0" default="" type="string">database name</param>

16210

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16211

16212

<insert>msql_createdb(string database name [,int link_identifier]);</insert>

16213

<dialog title="Insert msql_createdb">msql_createdb(%0, %1);</dialog>

16214

16215

</function>

16216

16217

<description>Move internal row pointer</description>

16218

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16219

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

16220

16221

<insert>msql_data_seek(int query_identifier, int row_number);</insert>

16222

16223

16224

</function>

16225

16226

<description>Get current mSQL database name</description>

16227

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16228

16229

<return type="string">string</return>

16230

<insert>msql_dbname(int query_identifier, int i);</insert>

16231

<dialog title="Insert msql_dbname">msql_dbname(%0, %1);</dialog>

16232

16233

</function>

16234

16235

<description>Drop (delete) mSQL database</description>

16236

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

16237

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

16238

16239

<insert>msql_drop_db(string database_name, int link_identifier);</insert>

16240

16241

16242

</function>

16243

16244

<description>Returns error message of last msql call</description>

16245

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16246

<return type="string">string</return>

16247

<insert>msql_error([int link_identifier]);</insert>

16248

<dialog title="Insert msql_error">msql_error(%0);</dialog>

16249

16250

</function>

16251

16252

<description>Fetch row as array</description>

16253

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16254

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

16255

16256

<insert>msql_fetch_array(int query_identifier [,int result_type]);</insert>

16257

<dialog title="Insert msql_fetch_array">msql_fetch_array(%0, %1);</dialog>

16258

16259

</function>

16260

16261

<description>Get field information</description>

16262

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16263

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

16264

<return type="object">object</return>

16265

<insert>msql_fetch_field(int query_identifier, int field_offset);</insert>

16266

<dialog title="Insert msql_fetch_field">msql_fetch_field(%0, %1);</dialog>

16267

16268

</function>

16269

16270

<description>Fetch row as object</description>

16271

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16272

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

16273

16274

<insert>msql_fetch_object(int query_identifier [,int result_type]);</insert>

16275

<dialog title="Insert msql_fetch_object">msql_fetch_object(%0, %1);</dialog>

16276

16277

</function>

16278

16279

<description>Get row as enumerated array</description>

16280

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16281

<return type="array">array</return>

16282

<insert>msql_fetch_row(int query_identifier);</insert>

16283

<dialog title="Insert msql_fetch_row">msql_fetch_row(%0);</dialog>

16284

16285

</function>

16286

16287

<description>Set field offset</description>

16288

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16289

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

16290

16291

<insert>msql_field_seek(int query_identifier, int field_offset);</insert>

16292

<dialog title="Insert msql_field_seek">msql_field_seek(%0, %1);</dialog>

16293

16294

</function>

16295

16296

<description>Get field flags</description>

16297

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16298

16299

<return type="string">string</return>

16300

<insert>msql_fieldflags(int query_identifier, int i);</insert>

16301

<dialog title="Insert msql_fieldflags">msql_fieldflags(%0, %1);</dialog>

16302

16303

</function>

16304

16305

<description>Get field length</description>

16306

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16307

16308

16309

<insert>msql_fieldlen(int query_identifier, int i);</insert>

16310

<dialog title="Insert msql_fieldlen">msql_fieldlen(%0, %1);</dialog>

16311

16312

</function>

16313

16314

<description>Get field name</description>

16315

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16316

<param name="field" required="1" vallist="0" default="" type="int">field</param>

16317

<return type="string">string</return>

16318

<insert>msql_fieldname(int query_identifier, int field);</insert>

16319

<dialog title="Insert msql_fieldname">msql_fieldname(%0, %1);</dialog>

16320

16321

</function>

16322

16323

<description>Get table name for field</description>

16324

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16325

<param name="field" required="1" vallist="0" default="" type="int">field</param>

16326

16327

<insert>msql_fieldtable(int query_identifier, int field);</insert>

16328

<dialog title="Insert msql_fieldtable">msql_fieldtable(%0, %1);</dialog>

16329

16330

</function>

16331

16332

<description>Get field type</description>

16333

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16334

16335

<return type="string">string</return>

16336

<insert>msql_fieldtype(int query_identifier, int i);</insert>

16337

<dialog title="Insert msql_fieldtype">msql_fieldtype(%0, %1);</dialog>

16338

16339

</function>

16340

16341

<description>Free result memory</description>

16342

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16343

16344

<insert>msql_free_result(int query_identifier);</insert>

16345

<dialog title="Insert msql_free_result">msql_free_result(%0);</dialog>

16346

16347

</function>

16348

16349

<description>List mSQL databases on server</description>

16350

16351

16352

16353

16354

</function>

16355

16356

<description>List result fields</description>

16357

<param name="database" required="1" vallist="0" default="" type="string">database</param>

16358

<param name="tablename" required="1" vallist="0" default="" type="string">tablename</param>

16359

16360

<insert>msql_list_fields(string database, string tablename);</insert>

16361

<dialog title="Insert msql_list_fields">msql_list_fields(%0, %1);</dialog>

16362

16363

</function>

16364

16365

<description>List tables in an mSQL database</description>

16366

<param name="database" required="1" vallist="0" default="" type="string">database</param>

16367

16368

<insert>msql_list_tables(string database);</insert>

16369

<dialog title="Insert msql_list_tables">msql_list_tables(%0);</dialog>

16370

16371

</function>

16372

16373

<description>Get number of fields in result</description>

16374

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16375

16376

<insert>msql_num_fields(int query_identifier);</insert>

16377

<dialog title="Insert msql_num_fields">msql_num_fields(%0);</dialog>

16378

16379

</function>

16380

16381

<description>Get number of rows in result</description>

16382

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16383

16384

<insert>msql_num_rows(int query_identifier);</insert>

16385

16386

16387

</function>

16388

16389

<description>Get number of fields in result</description>

16390

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16391

16392

<insert>msql_numfields(int query_identifier);</insert>

16393

<dialog title="Insert msql_numfields">msql_numfields(%0);</dialog>

16394

16395

</function>

16396

16397

<description>Get number of rows in result</description>

16398

16399

<insert>msql_numrows();</insert>

16400

<dialog title="Insert msql_numrows">msql_numrows();</dialog>

16401

16402

</function>

16403

16404

<description>Open persistent mSQL connection</description>

16405

<param name="

16406

server

16407

" required="0" vallist="0" default="" type="string">

16408

server

16409

</param>

16410

<param name="

16411

username

16412

" required="0" vallist="0" default="" type="string">

16413

username

16414

</param>

16415

<param name="

16416

password

16417

" required="0" vallist="0" default="" type="string">

16418

password

16419

</param>

16420

16421

<insert>msql_pconnect([string

16422

server

16423

] [,string

16424

username

16425

] [,string

16426

password

16427

]);</insert>

16428

<dialog title="Insert msql_pconnect">msql_pconnect(%0, %1, %2);</dialog>

16429

16430

</function>

16431

16432

<description>Send mSQL query</description>

16433

<param name="query" required="1" vallist="0" default="" type="string">query</param>

16434

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

16435

16436

<insert>msql_query(string query, int link_identifier);</insert>

16437

<dialog title="Insert msql_query">msql_query(%0, %1);</dialog>

16438

16439

</function>

16440

16441

<description>Get result data</description>

16442

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16443

16444

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

16445

16446

<insert>msql_result(int query_identifier, int i, mixed field);</insert>

16447

<dialog title="Insert msql_result">msql_result(%0, %1, %2);</dialog>

16448

16449

</function>

16450

16451

<description>Select mSQL database</description>

16452

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

16453

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

16454

16455

<insert>msql_select_db(string database_name, int link_identifier);</insert>

16456

<dialog title="Insert msql_select_db">msql_select_db(%0, %1);</dialog>

16457

16458

</function>

16459

16460

<description>Get table name of field</description>

16461

<param name="query_identifier" required="1" vallist="0" default="" type="int">query_identifier</param>

16462

<param name="field" required="1" vallist="0" default="" type="int">field</param>

16463

<return type="string">string</return>

16464

<insert>msql_tablename(int query_identifier, int field);</insert>

16465

<dialog title="Insert msql_tablename">msql_tablename(%0, %1);</dialog>

16466

16467

</function>

16468

16469

<description>Send mSQL query</description>

16470

<param name="database" required="1" vallist="0" default="" type="string">database</param>

16471

<param name="query" required="1" vallist="0" default="" type="string">query</param>

16472

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

16473

16474

<insert>msql(string database, string query, int link_identifier);</insert>

16475

16476

16477

</function>

16478

</group>

16479

16480

16481

16482

Adds a parameter to a stored procedure or a remote stored procedure

16483

</description>

16484

16485

<param name="param_name" required="1" vallist="0" default="" type="string">param_name</param>

16486

16487

16488

<param name="is_output" required="0" vallist="0" default="" type="int">is_output</param>

16489

16490

<param name="maxlen" required="0" vallist="0" default="" type="int">maxlen</param>

16491

16492

<insert>mssql_bind(int stmt, string param_name, mixed var, int type [,int is_output] [,int is_null] [,int maxlen]);</insert>

16493

<dialog title="Insert mssql_bind">mssql_bind(%0, %1, %2, %3, %4, %5, %6);</dialog>

16494

16495

</function>

16496

16497

<description>Close MS SQL Server connection</description>

16498

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16499

16500

<insert>mssql_close([int link_identifier]);</insert>

16501

<dialog title="Insert mssql_close">mssql_close(%0);</dialog>

16502

16503

</function>

16504

16505

<description>Open MS SQL server connection</description>

16506

<param name="servername" required="0" vallist="0" default="" type="string">servername</param>

16507

<param name="username" required="0" vallist="0" default="" type="string">username</param>

16508

<param name="password" required="0" vallist="0" default="" type="string">password</param>

16509

16510

<insert>mssql_connect([string servername] [,string username] [,string password]);</insert>

16511

<dialog title="Insert mssql_connect">mssql_connect(%0, %1, %2);</dialog>

16512

16513

</function>

16514

16515

<description>Move internal row pointer</description>

16516

<param name="result_identifier" required="1" vallist="0" default="" type="int">result_identifier</param>

16517

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

16518

16519

<insert>mssql_data_seek(int result_identifier, int row_number);</insert>

16520

<dialog title="Insert mssql_data_seek">mssql_data_seek(%0, %1);</dialog>

16521

16522

</function>

16523

16524

16525

Executes a stored procedure on a MS SQL server database

16526

</description>

16527

16528

16529

<insert>mssql_execute(int stmt);</insert>

16530

<dialog title="Insert mssql_execute">mssql_execute(%0);</dialog>

16531

16532

</function>

16533

16534

<description>Fetch row as array</description>

16535

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16536

<return type="array">array</return>

16537

<insert>mssql_fetch_array(int result);</insert>

16538

<dialog title="Insert mssql_fetch_array">mssql_fetch_array(%0);</dialog>

16539

16540

</function>

16541

16542

16543

Returns an associative array of the current row in the result set specified by result_id

16544

</description>

16545

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

16546

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

16547

<return type="array">array</return>

16548

<insert>mssql_fetch_assoc(int result_id [,int result_type]);</insert>

16549

<dialog title="Insert mssql_fetch_assoc">mssql_fetch_assoc(%0, %1);</dialog>

16550

16551

</function>

16552

16553

16554

Returns the next batch of records

16555

</description>

16556

<param name="result_index" required="1" vallist="0" default="" type="string">result_index</param>

16557

16558

<insert>mssql_fetch_batch(string result_index);</insert>

16559

<dialog title="Insert mssql_fetch_batch">mssql_fetch_batch(%0);</dialog>

16560

16561

</function>

16562

16563

<description>Get field information</description>

16564

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16565

<param name="field_offset" required="0" vallist="0" default="" type="int">field_offset</param>

16566

<return type="object">object</return>

16567

<insert>mssql_fetch_field(int result [,int field_offset]);</insert>

16568

<dialog title="Insert mssql_fetch_field">mssql_fetch_field(%0, %1);</dialog>

16569

16570

</function>

16571

16572

<description>Fetch row as object</description>

16573

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16574

<return type="object">object</return>

16575

<insert>mssql_fetch_object(int result);</insert>

16576

<dialog title="Insert mssql_fetch_object">mssql_fetch_object(%0);</dialog>

16577

16578

</function>

16579

16580

<description>Get row as enumerated array</description>

16581

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16582

<return type="array">array</return>

16583

<insert>mssql_fetch_row(int result);</insert>

16584

<dialog title="Insert mssql_fetch_row">mssql_fetch_row(%0);</dialog>

16585

16586

</function>

16587

16588

<description>Get the length of a field</description>

16589

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16590

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

16591

16592

<insert>mssql_field_length(int result [,int offset]);</insert>

16593

<dialog title="Insert mssql_field_length">mssql_field_length(%0, %1);</dialog>

16594

16595

</function>

16596

16597

<description>Get the name of a field</description>

16598

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16599

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

16600

16601

<insert>mssql_field_name(int result [,int offset]);</insert>

16602

<dialog title="Insert mssql_field_name">mssql_field_name(%0, %1);</dialog>

16603

16604

</function>

16605

16606

<description>Set field offset</description>

16607

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16608

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

16609

16610

<insert>mssql_field_seek(int result, int field_offset);</insert>

16611

<dialog title="Insert mssql_field_seek">mssql_field_seek(%0, %1);</dialog>

16612

16613

</function>

16614

16615

<description>Get the type of a field</description>

16616

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16617

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

16618

<return type="string">string</return>

16619

<insert>mssql_field_type(int result [,int offset]);</insert>

16620

<dialog title="Insert mssql_field_type">mssql_field_type(%0, %1);</dialog>

16621

16622

</function>

16623

16624

<description>Free result memory</description>

16625

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16626

16627

<insert>mssql_free_result(int result);</insert>

16628

<dialog title="Insert mssql_free_result">mssql_free_result(%0);</dialog>

16629

16630

</function>

16631

16632

<description>Free statement memory</description>

16633

<param name="statement" required="1" vallist="0" default="" type="int">statement</param>

16634

16635

<insert>mssql_free_statement(int statement);</insert>

16636

<dialog title="Insert mssql_free_statement">mssql_free_statement(%0);</dialog>

16637

16638

</function>

16639

16640

16641

Returns the last message from server (over

16642

min_message_severity?)

16643

</description>

16644

<return type="string">string</return>

16645

<insert>mssql_get_last_message();</insert>

16646

<dialog title="Insert mssql_get_last_message">mssql_get_last_message();</dialog>

16647

16648

</function>

16649

16650

16651

Converts a 16 byte binary GUID to a string

16652

</description>

16653

<param name="binary" required="1" vallist="0" default="" type="string">binary</param>

16654

<param name="short_format" required="0" vallist="0" default="" type="int">short_format</param>

16655

<return type="string">string</return>

16656

<insert>mssql_guid_string(string binary [,int short_format]);</insert>

16657

<dialog title="Insert mssql_guid_string">mssql_guid_string(%0, %1);</dialog>

16658

16659

</function>

16660

16661

16662

Initializes a stored procedure or a remote stored procedure

16663

</description>

16664

16665

16666

16667

<insert>mssql_init(string sp_name [,int conn_id]);</insert>

16668

<dialog title="Insert mssql_init">mssql_init(%0, %1);</dialog>

16669

16670

</function>

16671

16672

<description>Sets the lower error severity</description>

16673

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

16674

16675

<insert>mssql_min_error_severity(int severity);</insert>

16676

<dialog title="Insert mssql_min_error_severity">mssql_min_error_severity(%0);</dialog>

16677

16678

</function>

16679

16680

<description>Sets the lower message severity</description>

16681

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

16682

16683

<insert>mssql_min_message_severity(int severity);</insert>

16684

<dialog title="Insert mssql_min_message_severity">mssql_min_message_severity(%0);</dialog>

16685

16686

</function>

16687

16688

<description>Move the internal result pointer to the next result</description>

16689

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

16690

16691

<insert>mssql_next_result(int result_id);</insert>

16692

<dialog title="Insert mssql_next_result">mssql_next_result(%0);</dialog>

16693

16694

</function>

16695

16696

<description>Get number of fields in result</description>

16697

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16698

16699

<insert>mssql_num_fields(int result);</insert>

16700

<dialog title="Insert mssql_num_fields">mssql_num_fields(%0);</dialog>

16701

16702

</function>

16703

16704

<description>Get number of rows in result</description>

16705

<param name="result" required="1" vallist="0" default="" type="string">result</param>

16706

16707

<insert>mssql_num_rows(string result);</insert>

16708

<dialog title="Insert mssql_num_rows">mssql_num_rows(%0);</dialog>

16709

16710

</function>

16711

16712

<description>Open persistent MS SQL connection</description>

16713

<param name="servername" required="0" vallist="0" default="" type="string">servername</param>

16714

<param name="username" required="0" vallist="0" default="" type="string">username</param>

16715

<param name="password" required="0" vallist="0" default="" type="string">password</param>

16716

16717

<insert>mssql_pconnect([string servername] [,string username] [,string password]);</insert>

16718

<dialog title="Insert mssql_pconnect">mssql_pconnect(%0, %1, %2);</dialog>

16719

16720

</function>

16721

16722

<description>Send MS SQL query</description>

16723

<param name="query" required="1" vallist="0" default="" type="string">query</param>

16724

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16725

16726

<insert>mssql_query(string query [,int link_identifier]);</insert>

16727

<dialog title="Insert mssql_query">mssql_query(%0, %1);</dialog>

16728

16729

</function>

16730

16731

<description>Get result data</description>

16732

<param name="result" required="1" vallist="0" default="" type="int">result</param>

16733

16734

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

16735

16736

<insert>mssql_result(int result, int i, mixed field);</insert>

16737

<dialog title="Insert mssql_result">mssql_result(%0, %1, %2);</dialog>

16738

16739

</function>

16740

16741

16742

Returns the number of records affected by the query

16743

</description>

16744

16745

16746

<insert>mssql_rows_affected(int conn_id);</insert>

16747

<dialog title="Insert mssql_rows_affected">mssql_rows_affected(%0);</dialog>

16748

16749

</function>

16750

16751

<description>Select MS SQL database</description>

16752

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

16753

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

16754

16755

<insert>mssql_select_db(string database_name [,int link_identifier]);</insert>

16756

<dialog title="Insert mssql_select_db">mssql_select_db(%0, %1);</dialog>

16757

16758

</function>

16759

</group>

16760

16761

16762

<description>Shuts down the muscat session and releases any memory back to PHP.</description>

16763

<param name="muscat_handle" required="1" vallist="0" default="" type="resource">muscat_handle</param>

16764

16765

<insert>muscat_close(resource muscat_handle);</insert>

16766

<dialog title="Insert muscat_close">muscat_close(%0);</dialog>

16767

16768

</function>

16769

16770

<description>Gets a line back from the core muscat API. </description>

16771

<param name="muscat_handle" required="1" vallist="0" default="" type="resource">muscat_handle</param>

16772

<return type="string">string</return>

16773

<insert>muscat_get(resource muscat_handle);</insert>

16774

<dialog title="Insert muscat_get">muscat_get(%0);</dialog>

16775

16776

</function>

16777

16778

<description>Sends string to the core muscat API</description>

16779

<param name="muscat_handle" required="1" vallist="0" default="" type="resource">muscat_handle</param>

16780

<param name="string" required="1" vallist="0" default="" type="string">string</param>

16781

16782

<insert>muscat_give(resource muscat_handle, string string);</insert>

16783

<dialog title="Insert muscat_give">muscat_give(%0, %1);</dialog>

16784

16785

</function>

16786

16787

<description>Creates a new muscat session and returns the handle.</description>

16788

<param name="muscat_host" required="1" vallist="0" default="" type="string">muscat_host</param>

16789

16790

<return type="resource">resource</return>

16791

<insert>muscat_setup_net(string muscat_host, int port);</insert>

16792

<dialog title="Insert muscat_setup_net">muscat_setup_net(%0, %1);</dialog>

16793

16794

</function>

16795

16796

<description>Creates a new muscat session and returns the handle.</description>

16797

16798

<param name="muscat_dir" required="0" vallist="0" default="" type="string">muscat_dir</param>

16799

<return type="resource">resource</return>

16800

<insert>muscat_setup(int size [,string muscat_dir]);</insert>

16801

<dialog title="Insert muscat_setup">muscat_setup(%0, %1);</dialog>

16802

16803

</function>

16804

</group>

16805

16806

16807

<description>Get number of affected rows in previous MySQL

16808

operation</description>

16809

<param name="

16810

link_identifier

16811

" required="0" vallist="0" default="" type="resource">

16812

link_identifier

16813

</param>

16814

16815

<insert>mysql_affected_rows([resource

16816

link_identifier

16817

]);</insert>

16818

<dialog title="Insert mysql_affected_rows">mysql_affected_rows(%0);</dialog>

16819

16820

</function>

16821

16822

16823

Change logged in user of the active connection

16824

</description>

16825

16826

<param name="password" required="1" vallist="0" default="" type="string">password</param>

16827

<param name="

16828

database

16829

" required="0" vallist="0" default="" type="string">

16830

database

16831

</param>

16832

<param name="

16833

link_identifier

16834

" required="0" vallist="0" default="" type="resource">

16835

link_identifier

16836

</param>

16837

16838

<insert>mysql_change_user(string user, string password [,string

16839

database

16840

] [,resource

16841

link_identifier

16842

]);</insert>

16843

<dialog title="Insert mysql_change_user">mysql_change_user(%0, %1, %2, %3);</dialog>

16844

16845

</function>

16846

16847

<description>Returns the name of the character set</description>

16848

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

16849

16850

<insert>mysql_client_encoding([resource link_identifier]);</insert>

16851

<dialog title="Insert mysql_client_encoding">mysql_client_encoding(%0);</dialog>

16852

16853

</function>

16854

16855

<description>Close MySQL connection</description>

16856

<param name="

16857

link_identifier

16858

" required="0" vallist="0" default="" type="resource">

16859

link_identifier

16860

</param>

16861

16862

<insert>mysql_close([resource

16863

link_identifier

16864

]);</insert>

16865

<dialog title="Insert mysql_close">mysql_close(%0);</dialog>

16866

16867

</function>

16868

16869

<description>Open a connection to a MySQL Server</description>

16870

<param name="

16871

server

16872

" required="0" vallist="0" default="" type="string">

16873

server

16874

</param>

16875

<param name="

16876

username

16877

" required="0" vallist="0" default="" type="string">

16878

username

16879

</param>

16880

<param name="

16881

password

16882

" required="0" vallist="0" default="" type="string">

16883

password

16884

</param>

16885

<param name="

16886

new_link

16887

" required="0" vallist="0" default="" type="bool">

16888

new_link

16889

</param>

16890

<param name="

16891

client_flags

16892

" required="0" vallist="0" default="" type="int">

16893

client_flags

16894

</param>

16895

<return type="resource">resource</return>

16896

<insert>mysql_connect([string

16897

server

16898

] [,string

16899

username

16900

] [,string

16901

password

16902

] [,bool

16903

new_link

16904

] [,int

16905

client_flags

16906

]);</insert>

16907

<dialog title="Insert mysql_connect">mysql_connect(%0, %1, %2, %3, %4);</dialog>

16908

16909

</function>

16910

16911

<description>Create a MySQL database</description>

16912

<param name="database name" required="1" vallist="0" default="" type="string">database name</param>

16913

<param name="

16914

link_identifier

16915

" required="0" vallist="0" default="" type="resource">

16916

link_identifier

16917

</param>

16918

16919

<insert>mysql_create_db(string database name [,resource

16920

link_identifier

16921

]);</insert>

16922

<dialog title="Insert mysql_create_db">mysql_create_db(%0, %1);</dialog>

16923

16924

</function>

16925

16926

<description>Move internal result pointer</description>

16927

<param name="result_identifier" required="1" vallist="0" default="" type="resource">result_identifier</param>

16928

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

16929

16930

<insert>mysql_data_seek(resource result_identifier, int row_number);</insert>

16931

<dialog title="Insert mysql_data_seek">mysql_data_seek(%0, %1);</dialog>

16932

16933

</function>

16934

16935

<description>Get result data</description>

16936

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

16937

16938

<param name="

16939

field

16940

" required="0" vallist="0" default="" type="mixed">

16941

field

16942

</param>

16943

<return type="string">string</return>

16944

<insert>mysql_db_name(resource result, int row [,mixed

16945

field

16946

]);</insert>

16947

<dialog title="Insert mysql_db_name">mysql_db_name(%0, %1, %2);</dialog>

16948

16949

</function>

16950

16951

<description>Send a MySQL query</description>

16952

<param name="database" required="1" vallist="0" default="" type="string">database</param>

16953

<param name="query" required="1" vallist="0" default="" type="string">query</param>

16954

<param name="

16955

link_identifier

16956

" required="0" vallist="0" default="" type="resource">

16957

link_identifier

16958

</param>

16959

<return type="resource">resource</return>

16960

<insert>mysql_db_query(string database, string query [,resource

16961

link_identifier

16962

]);</insert>

16963

<dialog title="Insert mysql_db_query">mysql_db_query(%0, %1, %2);</dialog>

16964

16965

</function>

16966

16967

<description>Drop (delete) a MySQL database</description>

16968

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

16969

<param name="

16970

link_identifier

16971

" required="0" vallist="0" default="" type="resource">

16972

link_identifier

16973

</param>

16974

16975

<insert>mysql_drop_db(string database_name [,resource

16976

link_identifier

16977

]);</insert>

16978

<dialog title="Insert mysql_drop_db">mysql_drop_db(%0, %1);</dialog>

16979

16980

</function>

16981

16982

16983

Returns the numerical value of the error message from previous

16984

MySQL operation

16985

</description>

16986

<param name="

16987

link_identifier

16988

" required="0" vallist="0" default="" type="resource">

16989

link_identifier

16990

</param>

16991

16992

<insert>mysql_errno([resource

16993

link_identifier

16994

]);</insert>

16995

<dialog title="Insert mysql_errno">mysql_errno(%0);</dialog>

16996

16997

</function>

16998

16999

17000

Returns the text of the error message from previous MySQL

17001

operation

17002

</description>

17003

<param name="

17004

link_identifier

17005

" required="0" vallist="0" default="" type="resource">

17006

link_identifier

17007

</param>

17008

<return type="string">string</return>

17009

<insert>mysql_error([resource

17010

link_identifier

17011

]);</insert>

17012

<dialog title="Insert mysql_error">mysql_error(%0);</dialog>

17013

17014

</function>

17015

17016

17017

Escapes a string for use in a mysql_query.

17018

</description>

17019

<param name="unescaped_string" required="1" vallist="0" default="" type="string">unescaped_string</param>

17020

<return type="string">string</return>

17021

<insert>mysql_escape_string(string unescaped_string);</insert>

17022

<dialog title="Insert mysql_escape_string">mysql_escape_string(%0);</dialog>

17023

17024

</function>

17025

17026

17027

Fetch a result row as an associative array, a numeric array, or both.

17028

</description>

17029

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17030

<param name="

17031

result_type

17032

" required="0" vallist="0" default="" type="int">

17033

result_type

17034

</param>

17035

<return type="array">array</return>

17036

<insert>mysql_fetch_array(resource result [,int

17037

result_type

17038

]);</insert>

17039

<dialog title="Insert mysql_fetch_array">mysql_fetch_array(%0, %1);</dialog>

17040

17041

</function>

17042

17043

17044

Fetch a result row as an associative array

17045

</description>

17046

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17047

<return type="array">array</return>

17048

<insert>mysql_fetch_assoc(resource result);</insert>

17049

<dialog title="Insert mysql_fetch_assoc">mysql_fetch_assoc(%0);</dialog>

17050

17051

</function>

17052

17053

17054

Get column information from a result and return as an object

17055

</description>

17056

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17057

<param name="

17058

field_offset

17059

" required="0" vallist="0" default="" type="int">

17060

field_offset

17061

</param>

17062

<return type="object">object</return>

17063

<insert>mysql_fetch_field(resource result [,int

17064

field_offset

17065

]);</insert>

17066

<dialog title="Insert mysql_fetch_field">mysql_fetch_field(%0, %1);</dialog>

17067

17068

</function>

17069

17070

17071

Get the length of each output in a result

17072

</description>

17073

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17074

<return type="array">array</return>

17075

<insert>mysql_fetch_lengths(resource result);</insert>

17076

<dialog title="Insert mysql_fetch_lengths">mysql_fetch_lengths(%0);</dialog>

17077

17078

</function>

17079

17080

<description>Fetch a result row as an object</description>

17081

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17082

<return type="object">object</return>

17083

<insert>mysql_fetch_object(resource result);</insert>

17084

<dialog title="Insert mysql_fetch_object">mysql_fetch_object(%0);</dialog>

17085

17086

</function>

17087

17088

<description>Get a result row as an enumerated array</description>

17089

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17090

<return type="array">array</return>

17091

<insert>mysql_fetch_row(resource result);</insert>

17092

<dialog title="Insert mysql_fetch_row">mysql_fetch_row(%0);</dialog>

17093

17094

</function>

17095

17096

17097

Get the flags associated with the specified field in a result

17098

</description>

17099

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17100

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

17101

<return type="string">string</return>

17102

<insert>mysql_field_flags(resource result, int field_offset);</insert>

17103

<dialog title="Insert mysql_field_flags">mysql_field_flags(%0, %1);</dialog>

17104

17105

</function>

17106

17107

17108

Returns the length of the specified field

17109

</description>

17110

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17111

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

17112

17113

<insert>mysql_field_len(resource result, int field_offset);</insert>

17114

<dialog title="Insert mysql_field_len">mysql_field_len(%0, %1);</dialog>

17115

17116

</function>

17117

17118

17119

Get the name of the specified field in a result

17120

</description>

17121

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17122

<param name="field_index" required="1" vallist="0" default="" type="int">field_index</param>

17123

<return type="string">string</return>

17124

<insert>mysql_field_name(resource result, int field_index);</insert>

17125

<dialog title="Insert mysql_field_name">mysql_field_name(%0, %1);</dialog>

17126

17127

</function>

17128

17129

17130

Set result pointer to a specified field offset

17131

</description>

17132

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17133

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

17134

17135

<insert>mysql_field_seek(resource result, int field_offset);</insert>

17136

<dialog title="Insert mysql_field_seek">mysql_field_seek(%0, %1);</dialog>

17137

17138

</function>

17139

17140

17141

Get name of the table the specified field is in

17142

</description>

17143

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17144

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

17145

<return type="string">string</return>

17146

<insert>mysql_field_table(resource result, int field_offset);</insert>

17147

<dialog title="Insert mysql_field_table">mysql_field_table(%0, %1);</dialog>

17148

17149

</function>

17150

17151

17152

Get the type of the specified field in a result

17153

</description>

17154

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17155

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

17156

<return type="string">string</return>

17157

<insert>mysql_field_type(resource result, int field_offset);</insert>

17158

<dialog title="Insert mysql_field_type">mysql_field_type(%0, %1);</dialog>

17159

17160

</function>

17161

17162

<description>Free result memory</description>

17163

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17164

17165

<insert>mysql_free_result(resource result);</insert>

17166

<dialog title="Insert mysql_free_result">mysql_free_result(%0);</dialog>

17167

17168

</function>

17169

17170

<description>Get MySQL client info</description>

17171

<return type="string">string</return>

17172

<insert>mysql_get_client_info();</insert>

17173

<dialog title="Insert mysql_get_client_info">mysql_get_client_info();</dialog>

17174

17175

</function>

17176

17177

<description>Get MySQL host info</description>

17178

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17179

<return type="string">string</return>

17180

<insert>mysql_get_host_info([resource link_identifier]);</insert>

17181

<dialog title="Insert mysql_get_host_info">mysql_get_host_info(%0);</dialog>

17182

17183

</function>

17184

17185

<description>Get MySQL protocol info</description>

17186

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17187

17188

<insert>mysql_get_proto_info([resource link_identifier]);</insert>

17189

<dialog title="Insert mysql_get_proto_info">mysql_get_proto_info(%0);</dialog>

17190

17191

</function>

17192

17193

<description>Get MySQL server info</description>

17194

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17195

<return type="string">string</return>

17196

<insert>mysql_get_server_info([resource link_identifier]);</insert>

17197

<dialog title="Insert mysql_get_server_info">mysql_get_server_info(%0);</dialog>

17198

17199

</function>

17200

17201

17202

Get information about the most recent query

17203

</description>

17204

<param name="

17205

link_identifier

17206

" required="0" vallist="0" default="" type="resource">

17207

link_identifier

17208

</param>

17209

<return type="string">string</return>

17210

<insert>mysql_info([resource

17211

link_identifier

17212

]);</insert>

17213

<dialog title="Insert mysql_info">mysql_info(%0);</dialog>

17214

17215

</function>

17216

17217

17218

Get the ID generated from the previous INSERT operation

17219

</description>

17220

<param name="

17221

link_identifier

17222

" required="0" vallist="0" default="" type="resource">

17223

link_identifier

17224

</param>

17225

17226

<insert>mysql_insert_id([resource

17227

link_identifier

17228

]);</insert>

17229

<dialog title="Insert mysql_insert_id">mysql_insert_id(%0);</dialog>

17230

17231

</function>

17232

17233

17234

List databases available on a MySQL server

17235

</description>

17236

<param name="

17237

link_identifier

17238

" required="0" vallist="0" default="" type="resource">

17239

link_identifier

17240

</param>

17241

<return type="resource">resource</return>

17242

<insert>mysql_list_dbs([resource

17243

link_identifier

17244

]);</insert>

17245

<dialog title="Insert mysql_list_dbs">mysql_list_dbs(%0);</dialog>

17246

17247

</function>

17248

17249

<description>List MySQL result fields</description>

17250

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

17251

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

17252

<param name="

17253

link_identifier

17254

" required="0" vallist="0" default="" type="resource">

17255

link_identifier

17256

</param>

17257

<return type="resource">resource</return>

17258

<insert>mysql_list_fields(string database_name, string table_name [,resource

17259

link_identifier

17260

]);</insert>

17261

<dialog title="Insert mysql_list_fields">mysql_list_fields(%0, %1, %2);</dialog>

17262

17263

</function>

17264

17265

<description>List MySQL processes</description>

17266

<param name="

17267

link_identifier

17268

" required="0" vallist="0" default="" type="resource">

17269

link_identifier

17270

</param>

17271

<return type="resource">resource</return>

17272

<insert>mysql_list_processes([resource

17273

link_identifier

17274

]);</insert>

17275

<dialog title="Insert mysql_list_processes">mysql_list_processes(%0);</dialog>

17276

17277

</function>

17278

17279

<description>List tables in a MySQL database</description>

17280

<param name="database" required="1" vallist="0" default="" type="string">database</param>

17281

<param name="

17282

link_identifier

17283

" required="0" vallist="0" default="" type="resource">

17284

link_identifier

17285

</param>

17286

<return type="resource">resource</return>

17287

<insert>mysql_list_tables(string database [,resource

17288

link_identifier

17289

]);</insert>

17290

<dialog title="Insert mysql_list_tables">mysql_list_tables(%0, %1);</dialog>

17291

17292

</function>

17293

17294

<description>Get number of fields in result</description>

17295

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17296

17297

<insert>mysql_num_fields(resource result);</insert>

17298

<dialog title="Insert mysql_num_fields">mysql_num_fields(%0);</dialog>

17299

17300

</function>

17301

17302

<description>Get number of rows in result</description>

17303

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17304

17305

<insert>mysql_num_rows(resource result);</insert>

17306

<dialog title="Insert mysql_num_rows">mysql_num_rows(%0);</dialog>

17307

17308

</function>

17309

17310

17311

Open a persistent connection to a MySQL server

17312

</description>

17313

<param name="

17314

server

17315

" required="0" vallist="0" default="" type="string">

17316

server

17317

</param>

17318

<param name="username" required="0" vallist="0" default="" type="string">username</param>

17319

<param name="password" required="0" vallist="0" default="" type="string">password</param>

17320

<param name="client_flags" required="0" vallist="0" default="" type="int">client_flags</param>

17321

<return type="resource">resource</return>

17322

<insert>mysql_pconnect([string

17323

server

17324

] [,string username] [,string password] [,int client_flags]);</insert>

17325

<dialog title="Insert mysql_pconnect">mysql_pconnect(%0, %1, %2, %3);</dialog>

17326

17327

</function>

17328

17329

<description>Ping a server connection or reconnect if there is no connection</description>

17330

<param name="

17331

link_identifier

17332

" required="0" vallist="0" default="" type="resource">

17333

link_identifier

17334

</param>

17335

17336

<insert>mysql_ping([resource

17337

link_identifier

17338

]);</insert>

17339

<dialog title="Insert mysql_ping">mysql_ping(%0);</dialog>

17340

17341

</function>

17342

17343

<description>Send a MySQL query</description>

17344

<param name="query" required="1" vallist="0" default="" type="string">query</param>

17345

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17346

<param name="result_mode" required="0" vallist="0" default="" type="int">result_mode</param>

17347

<return type="resource">resource</return>

17348

<insert>mysql_query(string query [,resource link_identifier] [,int result_mode]);</insert>

17349

<dialog title="Insert mysql_query">mysql_query(%0, %1, %2);</dialog>

17350

17351

</function>

17352

17353

17354

Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection.

17355

</description>

17356

<param name="unescaped_string" required="1" vallist="0" default="" type="string">unescaped_string</param>

17357

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17358

<return type="string">string</return>

17359

<insert>mysql_real_escape_string(string unescaped_string [,resource link_identifier]);</insert>

17360

<dialog title="Insert mysql_real_escape_string">mysql_real_escape_string(%0, %1);</dialog>

17361

17362

</function>

17363

17364

<description>Get result data</description>

17365

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17366

17367

<param name="

17368

field

17369

" required="0" vallist="0" default="" type="mixed">

17370

field

17371

</param>

17372

<return type="mixed">mixed</return>

17373

<insert>mysql_result(resource result, int row [,mixed

17374

field

17375

]);</insert>

17376

<dialog title="Insert mysql_result">mysql_result(%0, %1, %2);</dialog>

17377

17378

</function>

17379

17380

<description>Select a MySQL database</description>

17381

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

17382

<param name="

17383

link_identifier

17384

" required="0" vallist="0" default="" type="resource">

17385

link_identifier

17386

</param>

17387

17388

<insert>mysql_select_db(string database_name [,resource

17389

link_identifier

17390

]);</insert>

17391

<dialog title="Insert mysql_select_db">mysql_select_db(%0, %1);</dialog>

17392

17393

</function>

17394

17395

<description>Get current system status</description>

17396

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17397

<return type="string">string</return>

17398

<insert>mysql_stat([resource link_identifier]);</insert>

17399

<dialog title="Insert mysql_stat">mysql_stat(%0);</dialog>

17400

17401

</function>

17402

17403

<description>Get table name of field</description>

17404

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

17405

17406

<return type="string">string</return>

17407

<insert>mysql_tablename(resource result, int i);</insert>

17408

<dialog title="Insert mysql_tablename">mysql_tablename(%0, %1);</dialog>

17409

17410

</function>

17411

17412

<description>Return the current thread ID</description>

17413

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17414

17415

<insert>mysql_thread_id([resource link_identifier]);</insert>

17416

<dialog title="Insert mysql_thread_id">mysql_thread_id(%0);</dialog>

17417

17418

</function>

17419

17420

17421

Send an SQL query to MySQL, without fetching and buffering the

17422

result rows

17423

</description>

17424

<param name="query" required="1" vallist="0" default="" type="string">query</param>

17425

<param name="link_identifier" required="0" vallist="0" default="" type="resource">link_identifier</param>

17426

<param name="result_mode" required="0" vallist="0" default="" type="int">result_mode</param>

17427

<return type="resource">resource</return>

17428

<insert>mysql_unbuffered_query(string query [,resource link_identifier] [,int result_mode]);</insert>

17429

<dialog title="Insert mysql_unbuffered_query">mysql_unbuffered_query(%0, %1, %2);</dialog>

17430

17431

</function>

17432

</group>

17433

17434

17435

<description>close connection</description>

17436

17437

17438

<insert>mysqli_close(resource link);</insert>

17439

<dialog title="Insert mysqli_close">mysqli_close(%0);</dialog>

17440

17441

</function>

17442

17443

<description>open a connection to a mysql server</description>

17444

<param name="hostname" required="0" vallist="0" default="" type="string">hostname</param>

17445

<param name="username" required="0" vallist="0" default="" type="string">username</param>

17446

<param name="passwd" required="0" vallist="0" default="" type="string">passwd</param>

17447

<param name="dbname" required="0" vallist="0" default="" type="string">dbname</param>

17448

17449

<param name="socket" required="0" vallist="0" default="" type="string">socket</param>

17450

<return type="resource">resource</return>

17451

<insert>mysqli_connect([string hostname] [,string username] [,string passwd] [,string dbname] [,int port] [,string socket]);</insert>

17452

<dialog title="Insert mysqli_connect">mysqli_connect(%0, %1, %2, %3, %4, %5);</dialog>

17453

17454

</function>

17455

17456

<description>set options</description>

17457

17458

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

17459

<param name="values" required="1" vallist="0" default="" type="mixed">values</param>

17460

17461

<insert>mysqli_options(resource link, int flags, mixed values);</insert>

17462

<dialog title="Insert mysqli_options">mysqli_options(%0, %1, %2);</dialog>

17463

17464

</function>

17465

17466

<description>return the number of parameter for the given statement</description>

17467

17468

17469

<insert>mysqli_param_count(resource stmt);</insert>

17470

<dialog title="Insert mysqli_param_count">mysqli_param_count(%0);</dialog>

17471

17472

</function>

17473

17474

<description>open a connection to a mysql server</description>

17475

17476

<param name="hostname" required="0" vallist="0" default="" type="string">hostname</param>

17477

<param name="username" required="0" vallist="0" default="" type="string">username</param>

17478

<param name="passwd" required="0" vallist="0" default="" type="string">passwd</param>

17479

<param name="dbname" required="0" vallist="0" default="" type="string">dbname</param>

17480

17481

<param name="socket" required="0" vallist="0" default="" type="string">socket</param>

17482

17483

<insert>mysqli_real_connect(resource link [,string hostname] [,string username] [,string passwd] [,string dbname] [,int port] [,string socket]);</insert>

17484

<dialog title="Insert mysqli_real_connect">mysqli_real_connect(%0, %1, %2, %3, %4, %5, %6);</dialog>

17485

17486

</function>

17487

17488

<description>close statement</description>

17489

17490

<param name="escapestr" required="1" vallist="0" default="" type="string">escapestr</param>

17491

<return type="string">string</return>

17492

<insert>mysqli_real_escape_string(resource link, string escapestr);</insert>

17493

<dialog title="Insert mysqli_real_escape_string">mysqli_real_escape_string(%0, %1);</dialog>

17494

17495

</function>

17496

17497

<description>close statement</description>

17498

17499

17500

<insert>mysqli_stmt_close(resource stmt);</insert>

17501

<dialog title="Insert mysqli_stmt_close">mysqli_stmt_close(%0);</dialog>

17502

17503

</function>

17504

</group>

17505

17506

17507

<description>Add character at current position and advance cursor </description>

17508

17509

17510

<insert>ncurses_addch(int ch);</insert>

17511

<dialog title="Insert ncurses_addch">ncurses_addch(%0);</dialog>

17512

17513

</function>

17514

17515

<description>Add attributed string with specified length at current position </description>

17516

17517

17518

17519

<insert>ncurses_addchnstr(string s, int n);</insert>

17520

<dialog title="Insert ncurses_addchnstr">ncurses_addchnstr(%0, %1);</dialog>

17521

17522

</function>

17523

17524

<description>Add attributed string at current position </description>

17525

17526

17527

<insert>ncurses_addchstr(string s);</insert>

17528

<dialog title="Insert ncurses_addchstr">ncurses_addchstr(%0);</dialog>

17529

17530

</function>

17531

17532

<description>Add string with specified length at current position </description>

17533

17534

17535

17536

<insert>ncurses_addnstr(string s, int n);</insert>

17537

<dialog title="Insert ncurses_addnstr">ncurses_addnstr(%0, %1);</dialog>

17538

17539

</function>

17540

17541

<description>Output text at current position </description>

17542

17543

17544

<insert>ncurses_addstr(string text);</insert>

17545

<dialog title="Insert ncurses_addstr">ncurses_addstr(%0);</dialog>

17546

17547

</function>

17548

17549

<description>Define default colors for color 0 </description>

17550

17551

17552

17553

<insert>ncurses_assume_default_colors(int fg, int bg);</insert>

17554

<dialog title="Insert ncurses_assume_default_colors">ncurses_assume_default_colors(%0, %1);</dialog>

17555

17556

</function>

17557

17558

<description>Turn off the given attributes </description>

17559

<param name="attributes" required="1" vallist="0" default="" type="int">attributes</param>

17560

17561

<insert>ncurses_attroff(int attributes);</insert>

17562

<dialog title="Insert ncurses_attroff">ncurses_attroff(%0);</dialog>

17563

17564

</function>

17565

17566

<description>Turn on the given attributes </description>

17567

<param name="attributes" required="1" vallist="0" default="" type="int">attributes</param>

17568

17569

<insert>ncurses_attron(int attributes);</insert>

17570

<dialog title="Insert ncurses_attron">ncurses_attron(%0);</dialog>

17571

17572

</function>

17573

17574

<description>Set given attributes </description>

17575

<param name="attributes" required="1" vallist="0" default="" type="int">attributes</param>

17576

17577

<insert>ncurses_attrset(int attributes);</insert>

17578

<dialog title="Insert ncurses_attrset">ncurses_attrset(%0);</dialog>

17579

17580

</function>

17581

17582

<description>Returns baudrate of terminal </description>

17583

17584

<insert>ncurses_baudrate();</insert>

17585

<dialog title="Insert ncurses_baudrate">ncurses_baudrate();</dialog>

17586

17587

</function>

17588

17589

<description>Let the terminal beep </description>

17590

17591

<insert>ncurses_beep();</insert>

17592

<dialog title="Insert ncurses_beep">ncurses_beep();</dialog>

17593

17594

</function>

17595

17596

<description>Set background property for terminal screen </description>

17597

<param name="attrchar" required="1" vallist="0" default="" type="int">attrchar</param>

17598

17599

<insert>ncurses_bkgd(int attrchar);</insert>

17600

<dialog title="Insert ncurses_bkgd">ncurses_bkgd(%0);</dialog>

17601

17602

</function>

17603

17604

<description>Control screen background </description>

17605

<param name="attrchar" required="1" vallist="0" default="" type="int">attrchar</param>

17606

17607

<insert>ncurses_bkgdset(int attrchar);</insert>

17608

<dialog title="Insert ncurses_bkgdset">ncurses_bkgdset(%0);</dialog>

17609

17610

</function>

17611

17612

<description>Draw a border around the screen using attributed characters </description>

17613

17614

<param name="right" required="1" vallist="0" default="" type="int">right</param>

17615

17616

<param name="bottom" required="1" vallist="0" default="" type="int">bottom</param>

17617

<param name="tl_corner" required="1" vallist="0" default="" type="int">tl_corner</param>

17618

<param name="tr_corner" required="1" vallist="0" default="" type="int">tr_corner</param>

17619

<param name="bl_corner" required="1" vallist="0" default="" type="int">bl_corner</param>

17620

<param name="br_corner" required="1" vallist="0" default="" type="int">br_corner</param>

17621

17622

<insert>ncurses_border(int left, int right, int top, int bottom, int tl_corner, int tr_corner, int bl_corner, int br_corner);</insert>

17623

<dialog title="Insert ncurses_border">ncurses_border(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

17624

17625

</function>

17626

17627

<description>Check if we can change terminals colors </description>

17628

17629

<insert>ncurses_can_change_color();</insert>

17630

<dialog title="Insert ncurses_can_change_color">ncurses_can_change_color();</dialog>

17631

17632

</function>

17633

17634

<description>Switch of input buffering </description>

17635

17636

<insert>ncurses_cbreak();</insert>

17637

<dialog title="Insert ncurses_cbreak">ncurses_cbreak();</dialog>

17638

17639

</function>

17640

17641

<description>Clear screen </description>

17642

17643

<insert>ncurses_clear();</insert>

17644

<dialog title="Insert ncurses_clear">ncurses_clear();</dialog>

17645

17646

</function>

17647

17648

<description>Clear screen from current position to bottom </description>

17649

17650

<insert>ncurses_clrtobot();</insert>

17651

<dialog title="Insert ncurses_clrtobot">ncurses_clrtobot();</dialog>

17652

17653

</function>

17654

17655

<description>Clear screen from current position to end of line </description>

17656

17657

<insert>ncurses_clrtoeol();</insert>

17658

<dialog title="Insert ncurses_clrtoeol">ncurses_clrtoeol();</dialog>

17659

17660

</function>

17661

17662

<description>Set fore- and background color </description>

17663

17664

17665

<insert>ncurses_color_set(int pair);</insert>

17666

<dialog title="Insert ncurses_color_set">ncurses_color_set(%0);</dialog>

17667

17668

</function>

17669

17670

<description>Set cursor state </description>

17671

<param name="visibility" required="1" vallist="0" default="" type="int">visibility</param>

17672

17673

<insert>ncurses_curs_set(int visibility);</insert>

17674

<dialog title="Insert ncurses_curs_set">ncurses_curs_set(%0);</dialog>

17675

17676

</function>

17677

17678

<description>Saves terminals (program) mode</description>

17679

17680

<insert>ncurses_def_prog_mode();</insert>

17681

<dialog title="Insert ncurses_def_prog_mode">ncurses_def_prog_mode();</dialog>

17682

17683

</function>

17684

17685

<description>Saves terminals (shell) mode</description>

17686

17687

<insert>ncurses_def_shell_mode();</insert>

17688

<dialog title="Insert ncurses_def_shell_mode">ncurses_def_shell_mode();</dialog>

17689

17690

</function>

17691

17692

<description>Define a keycode </description>

17693

<param name="definition" required="1" vallist="0" default="" type="string">definition</param>

17694

<param name="keycode" required="1" vallist="0" default="" type="int">keycode</param>

17695

17696

<insert>ncurses_define_key(string definition, int keycode);</insert>

17697

<dialog title="Insert ncurses_define_key">ncurses_define_key(%0, %1);</dialog>

17698

17699

</function>

17700

17701

<description>Delay output on terminal using padding characters </description>

17702

<param name="milliseconds" required="1" vallist="0" default="" type="int">milliseconds</param>

17703

17704

<insert>ncurses_delay_output(int milliseconds);</insert>

17705

<dialog title="Insert ncurses_delay_output">ncurses_delay_output(%0);</dialog>

17706

17707

</function>

17708

17709

<description>Delete character at current position, move rest of line left </description>

17710

17711

<insert>ncurses_delch();</insert>

17712

<dialog title="Insert ncurses_delch">ncurses_delch();</dialog>

17713

17714

</function>

17715

17716

<description>Delete line at current position, move rest of screen up </description>

17717

17718

<insert>ncurses_deleteln();</insert>

17719

<dialog title="Insert ncurses_deleteln">ncurses_deleteln();</dialog>

17720

17721

</function>

17722

17723

<description>Delete a ncurses window </description>

17724

<param name="window" required="1" vallist="0" default="" type="resource">window</param>

17725

17726

<insert>ncurses_delwin(resource window);</insert>

17727

<dialog title="Insert ncurses_delwin">ncurses_delwin(%0);</dialog>

17728

17729

</function>

17730

17731

<description>Write all prepared refreshes to terminal </description>

17732

17733

<insert>ncurses_doupdate();</insert>

17734

<dialog title="Insert ncurses_doupdate">ncurses_doupdate();</dialog>

17735

17736

</function>

17737

17738

<description>Activate keyboard input echo </description>

17739

17740

<insert>ncurses_echo();</insert>

17741

<dialog title="Insert ncurses_echo">ncurses_echo();</dialog>

17742

17743

</function>

17744

17745

<description>Single character output including refresh </description>

17746

<param name="character" required="1" vallist="0" default="" type="int">character</param>

17747

17748

<insert>ncurses_echochar(int character);</insert>

17749

<dialog title="Insert ncurses_echochar">ncurses_echochar(%0);</dialog>

17750

17751

</function>

17752

17753

<description>Stop using ncurses, clean up the screen </description>

17754

17755

<insert>ncurses_end();</insert>

17756

<dialog title="Insert ncurses_end">ncurses_end();</dialog>

17757

17758

</function>

17759

17760

<description>Erase terminal screen </description>

17761

17762

<insert>ncurses_erase();</insert>

17763

<dialog title="Insert ncurses_erase">ncurses_erase();</dialog>

17764

17765

</function>

17766

17767

<description>Returns current erase character </description>

17768

<return type="string">string</return>

17769

<insert>ncurses_erasechar();</insert>

17770

<dialog title="Insert ncurses_erasechar">ncurses_erasechar();</dialog>

17771

17772

</function>

17773

17774

<description>Flash terminal screen (visual bell) </description>

17775

17776

<insert>ncurses_flash();</insert>

17777

<dialog title="Insert ncurses_flash">ncurses_flash();</dialog>

17778

17779

</function>

17780

17781

<description>Flush keyboard input buffer </description>

17782

17783

<insert>ncurses_flushinp();</insert>

17784

<dialog title="Insert ncurses_flushinp">ncurses_flushinp();</dialog>

17785

17786

</function>

17787

17788

<description>Read a character from keyboard </description>

17789

17790

<insert>ncurses_getch();</insert>

17791

<dialog title="Insert ncurses_getch">ncurses_getch();</dialog>

17792

17793

</function>

17794

17795

<description>Reads mouse event</description>

17796

<param name="mevent" required="1" vallist="0" default="" type="array">mevent</param>

17797

17798

<insert>ncurses_getmouse(array mevent);</insert>

17799

<dialog title="Insert ncurses_getmouse">ncurses_getmouse(%0);</dialog>

17800

17801

</function>

17802

17803

<description>Put terminal into halfdelay mode </description>

17804

<param name="tenth" required="1" vallist="0" default="" type="int">tenth</param>

17805

17806

<insert>ncurses_halfdelay(int tenth);</insert>

17807

<dialog title="Insert ncurses_halfdelay">ncurses_halfdelay(%0);</dialog>

17808

17809

</function>

17810

17811

<description>Check if terminal has colors </description>

17812

17813

<insert>ncurses_has_colors();</insert>

17814

<dialog title="Insert ncurses_has_colors">ncurses_has_colors();</dialog>

17815

17816

</function>

17817

17818

<description>Check for insert- and delete-capabilities </description>

17819

17820

<insert>ncurses_has_ic();</insert>

17821

<dialog title="Insert ncurses_has_ic">ncurses_has_ic();</dialog>

17822

17823

</function>

17824

17825

<description>Check for line insert- and delete-capabilities </description>

17826

17827

<insert>ncurses_has_il();</insert>

17828

<dialog title="Insert ncurses_has_il">ncurses_has_il();</dialog>

17829

17830

</function>

17831

17832

<description>Check for presence of a function key on terminal keyboard </description>

17833

<param name="keycode" required="1" vallist="0" default="" type="int">keycode</param>

17834

17835

<insert>ncurses_has_key(int keycode);</insert>

17836

<dialog title="Insert ncurses_has_key">ncurses_has_key(%0);</dialog>

17837

17838

</function>

17839

17840

<description>Draw a horizontal line at current position using an attributed character and max. n characters long </description>

17841

<param name="charattr" required="1" vallist="0" default="" type="int">charattr</param>

17842

17843

17844

<insert>ncurses_hline(int charattr, int n);</insert>

17845

<dialog title="Insert ncurses_hline">ncurses_hline(%0, %1);</dialog>

17846

17847

</function>

17848

17849

<description>Get character and attribute at current position </description>

17850

<return type="string">string</return>

17851

<insert>ncurses_inch();</insert>

17852

<dialog title="Insert ncurses_inch">ncurses_inch();</dialog>

17853

17854

</function>

17855

17856

<description>Set new RGB value for color </description>

17857

<param name="color" required="1" vallist="0" default="" type="int">color</param>

17858

17859

17860

17861

17862

<insert>ncurses_init_color(int color, int r, int g, int b);</insert>

17863

<dialog title="Insert ncurses_init_color">ncurses_init_color(%0, %1, %2, %3);</dialog>

17864

17865

</function>

17866

17867

<description>Allocate a color pair </description>

17868

17869

17870

17871

17872

<insert>ncurses_init_pair(int pair, int fg, int bg);</insert>

17873

<dialog title="Insert ncurses_init_pair">ncurses_init_pair(%0, %1, %2);</dialog>

17874

17875

</function>

17876

17877

<description>Initialize ncurses </description>

17878

17879

<insert>ncurses_init();</insert>

17880

<dialog title="Insert ncurses_init">ncurses_init();</dialog>

17881

17882

</function>

17883

17884

<description>Insert character moving rest of line including character at current position </description>

17885

<param name="character" required="1" vallist="0" default="" type="int">character</param>

17886

17887

<insert>ncurses_insch(int character);</insert>

17888

<dialog title="Insert ncurses_insch">ncurses_insch(%0);</dialog>

17889

17890

</function>

17891

17892

<description>Insert lines before current line scrolling down (negative numbers delete and scroll up) </description>

17893

<param name="count" required="1" vallist="0" default="" type="int">count</param>

17894

17895

<insert>ncurses_insdelln(int count);</insert>

17896

<dialog title="Insert ncurses_insdelln">ncurses_insdelln(%0);</dialog>

17897

17898

</function>

17899

17900

<description>Insert a line, move rest of screen down </description>

17901

17902

<insert>ncurses_insertln();</insert>

17903

<dialog title="Insert ncurses_insertln">ncurses_insertln();</dialog>

17904

17905

</function>

17906

17907

<description>Insert string at current position, moving rest of line right </description>

17908

17909

17910

<insert>ncurses_insstr(string text);</insert>

17911

<dialog title="Insert ncurses_insstr">ncurses_insstr(%0);</dialog>

17912

17913

</function>

17914

17915

<description>Reads string from terminal screen </description>

17916

<param name="buffer" required="1" vallist="0" default="" type="string">buffer</param>

17917

17918

<insert>ncurses_instr(string buffer);</insert>

17919

<dialog title="Insert ncurses_instr">ncurses_instr(%0);</dialog>

17920

17921

</function>

17922

17923

<description>Ncurses is in endwin mode, normal screen output may be performed </description>

17924

17925

<insert>ncurses_isendwin();</insert>

17926

<dialog title="Insert ncurses_isendwin">ncurses_isendwin();</dialog>

17927

17928

</function>

17929

17930

<description>Enable or disable a keycode </description>

17931

<param name="keycode" required="1" vallist="0" default="" type="int">keycode</param>

17932

<param name="enable" required="1" vallist="0" default="" type="bool">enable</param>

17933

17934

<insert>ncurses_keyok(int keycode, bool enable);</insert>

17935

<dialog title="Insert ncurses_keyok">ncurses_keyok(%0, %1);</dialog>

17936

17937

</function>

17938

17939

<description>Returns current line kill character </description>

17940

17941

<insert>ncurses_killchar();</insert>

17942

<dialog title="Insert ncurses_killchar">ncurses_killchar();</dialog>

17943

17944

</function>

17945

17946

<description>Returns terminals description</description>

17947

<return type="string">string</return>

17948

<insert>ncurses_longname();</insert>

17949

<dialog title="Insert ncurses_longname">ncurses_longname();</dialog>

17950

17951

</function>

17952

17953

<description>Set timeout for mouse button clicks </description>

17954

<param name="milliseconds" required="1" vallist="0" default="" type="int">milliseconds</param>

17955

17956

<insert>ncurses_mouseinterval(int milliseconds);</insert>

17957

<dialog title="Insert ncurses_mouseinterval">ncurses_mouseinterval(%0);</dialog>

17958

17959

</function>

17960

17961

<description>Sets mouse options</description>

17962

<param name="newmask" required="1" vallist="0" default="" type="int">newmask</param>

17963

<param name="oldmask" required="1" vallist="0" default="" type="int">oldmask</param>

17964

17965

<insert>ncurses_mousemask(int newmask, int oldmask);</insert>

17966

<dialog title="Insert ncurses_mousemask">ncurses_mousemask(%0, %1);</dialog>

17967

17968

</function>

17969

17970

<description>Move output position </description>

17971

17972

17973

17974

<insert>ncurses_move(int y, int x);</insert>

17975

<dialog title="Insert ncurses_move">ncurses_move(%0, %1);</dialog>

17976

17977

</function>

17978

17979

<description>Move current position and add character </description>

17980

17981

17982

17983

17984

<insert>ncurses_mvaddch(int y, int x, int c);</insert>

17985

<dialog title="Insert ncurses_mvaddch">ncurses_mvaddch(%0, %1, %2);</dialog>

17986

17987

</function>

17988

17989

<description>Move position and add attrributed string with specified length </description>

17990

17991

17992

17993

17994

17995

<insert>ncurses_mvaddchnstr(int y, int x, string s, int n);</insert>

17996

<dialog title="Insert ncurses_mvaddchnstr">ncurses_mvaddchnstr(%0, %1, %2, %3);</dialog>

17997

17998

</function>

17999

18000

<description>Move position and add attributed string </description>

18001

18002

18003

18004

18005

<insert>ncurses_mvaddchstr(int y, int x, string s);</insert>

18006

<dialog title="Insert ncurses_mvaddchstr">ncurses_mvaddchstr(%0, %1, %2);</dialog>

18007

18008

</function>

18009

18010

<description>Move position and add string with specified length </description>

18011

18012

18013

18014

18015

18016

<insert>ncurses_mvaddnstr(int y, int x, string s, int n);</insert>

18017

<dialog title="Insert ncurses_mvaddnstr">ncurses_mvaddnstr(%0, %1, %2, %3);</dialog>

18018

18019

</function>

18020

18021

<description>Move position and add string </description>

18022

18023

18024

18025

18026

<insert>ncurses_mvaddstr(int y, int x, string s);</insert>

18027

<dialog title="Insert ncurses_mvaddstr">ncurses_mvaddstr(%0, %1, %2);</dialog>

18028

18029

</function>

18030

18031

<description>Move cursor immediately </description>

18032

18033

18034

18035

18036

18037

<insert>ncurses_mvcur(int old_y, int old_x, int new_y, int new_x);</insert>

18038

<dialog title="Insert ncurses_mvcur">ncurses_mvcur(%0, %1, %2, %3);</dialog>

18039

18040

</function>

18041

18042

<description>Move position and delete character, shift rest of line left </description>

18043

18044

18045

18046

<insert>ncurses_mvdelch(int y, int x);</insert>

18047

<dialog title="Insert ncurses_mvdelch">ncurses_mvdelch(%0, %1);</dialog>

18048

18049

</function>

18050

18051

<description>Move position and get character at new position </description>

18052

18053

18054

18055

<insert>ncurses_mvgetch(int y, int x);</insert>

18056

<dialog title="Insert ncurses_mvgetch">ncurses_mvgetch(%0, %1);</dialog>

18057

18058

</function>

18059

18060

<description>Set new position and draw a horizontal line using an attributed character and max. n characters long </description>

18061

18062

18063

<param name="attrchar" required="1" vallist="0" default="" type="int">attrchar</param>

18064

18065

18066

<insert>ncurses_mvhline(int y, int x, int attrchar, int n);</insert>

18067

<dialog title="Insert ncurses_mvhline">ncurses_mvhline(%0, %1, %2, %3);</dialog>

18068

18069

</function>

18070

18071

<description>Move position and get attributed character at new position </description>

18072

18073

18074

18075

<insert>ncurses_mvinch(int y, int x);</insert>

18076

<dialog title="Insert ncurses_mvinch">ncurses_mvinch(%0, %1);</dialog>

18077

18078

</function>

18079

18080

<description>Set new position and draw a vertical line using an attributed character and max. n characters long </description>

18081

18082

18083

<param name="attrchar" required="1" vallist="0" default="" type="int">attrchar</param>

18084

18085

18086

<insert>ncurses_mvvline(int y, int x, int attrchar, int n);</insert>

18087

<dialog title="Insert ncurses_mvvline">ncurses_mvvline(%0, %1, %2, %3);</dialog>

18088

18089

</function>

18090

18091

<description>Add string at new position in window </description>

18092

<param name="window" required="1" vallist="0" default="" type="resource">window</param>

18093

18094

18095

18096

18097

<insert>ncurses_mvwaddstr(resource window, int y, int x, string text);</insert>

18098

<dialog title="Insert ncurses_mvwaddstr">ncurses_mvwaddstr(%0, %1, %2, %3);</dialog>

18099

18100

</function>

18101

18102

<description>Sleep </description>

18103

<param name="milliseconds" required="1" vallist="0" default="" type="int">milliseconds</param>

18104

18105

<insert>ncurses_napms(int milliseconds);</insert>

18106

<dialog title="Insert ncurses_napms">ncurses_napms(%0);</dialog>

18107

18108

</function>

18109

18110

<description>Create a new window </description>

18111

18112

18113

18114

18115

18116

<insert>ncurses_newwin(int rows, int cols, int y, int x);</insert>

18117

<dialog title="Insert ncurses_newwin">ncurses_newwin(%0, %1, %2, %3);</dialog>

18118

18119

</function>

18120

18121

<description>Translate newline and carriage return / line feed </description>

18122

18123

<insert>ncurses_nl();</insert>

18124

<dialog title="Insert ncurses_nl">ncurses_nl();</dialog>

18125

18126

</function>

18127

18128

<description>Switch terminal to cooked mode </description>

18129

18130

<insert>ncurses_nocbreak();</insert>

18131

<dialog title="Insert ncurses_nocbreak">ncurses_nocbreak();</dialog>

18132

18133

</function>

18134

18135

<description>Switch off keyboard input echo </description>

18136

18137

<insert>ncurses_noecho();</insert>

18138

<dialog title="Insert ncurses_noecho">ncurses_noecho();</dialog>

18139

18140

</function>

18141

18142

<description>Do not translate newline and carriage return / line feed </description>

18143

18144

<insert>ncurses_nonl();</insert>

18145

<dialog title="Insert ncurses_nonl">ncurses_nonl();</dialog>

18146

18147

</function>

18148

18149

<description>Do not flush on signal characters</description>

18150

18151

<insert>ncurses_noqiflush();</insert>

18152

<dialog title="Insert ncurses_noqiflush">ncurses_noqiflush();</dialog>

18153

18154

</function>

18155

18156

<description>Switch terminal out of raw mode </description>

18157

18158

<insert>ncurses_noraw();</insert>

18159

<dialog title="Insert ncurses_noraw">ncurses_noraw();</dialog>

18160

18161

</function>

18162

18163

<description>Flush on signal characters </description>

18164

18165

<insert>ncurses_qiflush();</insert>

18166

<dialog title="Insert ncurses_qiflush">ncurses_qiflush();</dialog>

18167

18168

</function>

18169

18170

<description>Switch terminal into raw mode </description>

18171

18172

<insert>ncurses_raw();</insert>

18173

<dialog title="Insert ncurses_raw">ncurses_raw();</dialog>

18174

18175

</function>

18176

18177

<description>Refresh screen </description>

18178

18179

18180

<insert>ncurses_refresh(int ch);</insert>

18181

<dialog title="Insert ncurses_refresh">ncurses_refresh(%0);</dialog>

18182

18183

</function>

18184

18185

<description>Restores saved terminal state </description>

18186

18187

<insert>ncurses_resetty();</insert>

18188

<dialog title="Insert ncurses_resetty">ncurses_resetty();</dialog>

18189

18190

</function>

18191

18192

<description>Saves terminal state </description>

18193

18194

<insert>ncurses_savetty();</insert>

18195

<dialog title="Insert ncurses_savetty">ncurses_savetty();</dialog>

18196

18197

</function>

18198

18199

<description>Dump screen content to file </description>

18200

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

18201

18202

<insert>ncurses_scr_dump(string filename);</insert>

18203

<dialog title="Insert ncurses_scr_dump">ncurses_scr_dump(%0);</dialog>

18204

18205

</function>

18206

18207

<description>Initialize screen from file dump </description>

18208

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

18209

18210

<insert>ncurses_scr_init(string filename);</insert>

18211

<dialog title="Insert ncurses_scr_init">ncurses_scr_init(%0);</dialog>

18212

18213

</function>

18214

18215

<description>Restore screen from file dump </description>

18216

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

18217

18218

<insert>ncurses_scr_restore(string filename);</insert>

18219

<dialog title="Insert ncurses_scr_restore">ncurses_scr_restore(%0);</dialog>

18220

18221

</function>

18222

18223

<description>Inherit screen from file dump </description>

18224

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

18225

18226

<insert>ncurses_scr_set(string filename);</insert>

18227

<dialog title="Insert ncurses_scr_set">ncurses_scr_set(%0);</dialog>

18228

18229

</function>

18230

18231

<description>Scroll window content up or down without changing current position </description>

18232

<param name="count" required="1" vallist="0" default="" type="int">count</param>

18233

18234

<insert>ncurses_scrl(int count);</insert>

18235

<dialog title="Insert ncurses_scrl">ncurses_scrl(%0);</dialog>

18236

18237

</function>

18238

18239

<description>Returns current soft label key attribute</description>

18240

18241

<insert>ncurses_slk_attr();</insert>

18242

<dialog title="Insert ncurses_slk_attr">ncurses_slk_attr();</dialog>

18243

18244

</function>

18245

18246

<description>Clears soft labels from screen</description>

18247

18248

<insert>ncurses_slk_clear();</insert>

18249

<dialog title="Insert ncurses_slk_clear">ncurses_slk_clear();</dialog>

18250

18251

</function>

18252

18253

<description>Sets color for soft label keys</description>

18254

<param name="intarg" required="1" vallist="0" default="" type="int">intarg</param>

18255

18256

<insert>ncurses_slk_color(int intarg);</insert>

18257

<dialog title="Insert ncurses_slk_color">ncurses_slk_color(%0);</dialog>

18258

18259

</function>

18260

18261

<description>Initializes soft label key functions</description>

18262

<param name="format" required="1" vallist="0" default="" type="int">format</param>

18263

18264

<insert>ncurses_slk_init(int format);</insert>

18265

<dialog title="Insert ncurses_slk_init">ncurses_slk_init(%0);</dialog>

18266

18267

</function>

18268

18269

<description>Copies soft label keys to virtual screen</description>

18270

18271

<insert>ncurses_slk_noutrefresh();</insert>

18272

<dialog title="Insert ncurses_slk_noutrefresh">ncurses_slk_noutrefresh();</dialog>

18273

18274

</function>

18275

18276

<description>Copies soft label keys to screen</description>

18277

18278

<insert>ncurses_slk_refresh();</insert>

18279

<dialog title="Insert ncurses_slk_refresh">ncurses_slk_refresh();</dialog>

18280

18281

</function>

18282

18283

<description>Restores soft label keys</description>

18284

18285

<insert>ncurses_slk_restore();</insert>

18286

<dialog title="Insert ncurses_slk_restore">ncurses_slk_restore();</dialog>

18287

18288

</function>

18289

18290

<description>Fources output when ncurses_slk_noutrefresh is performed</description>

18291

18292

<insert>ncurses_slk_touch();</insert>

18293

<dialog title="Insert ncurses_slk_touch">ncurses_slk_touch();</dialog>

18294

18295

</function>

18296

18297

<description>Stop using 'standout' attribute </description>

18298

18299

<insert>ncurses_standend();</insert>

18300

<dialog title="Insert ncurses_standend">ncurses_standend();</dialog>

18301

18302

</function>

18303

18304

<description>Start using 'standout' attribute </description>

18305

18306

<insert>ncurses_standout();</insert>

18307

<dialog title="Insert ncurses_standout">ncurses_standout();</dialog>

18308

18309

</function>

18310

18311

<description>Start using colors </description>

18312

18313

<insert>ncurses_start_color();</insert>

18314

<dialog title="Insert ncurses_start_color">ncurses_start_color();</dialog>

18315

18316

</function>

18317

18318

<description>Returns a logical OR of all attribute flags supported by terminal </description>

18319

18320

<insert>ncurses_termattrs();</insert>

18321

<dialog title="Insert ncurses_termattrs">ncurses_termattrs();</dialog>

18322

18323

</function>

18324

18325

<description>Returns terminals (short)-name</description>

18326

<return type="string">string</return>

18327

<insert>ncurses_termname();</insert>

18328

<dialog title="Insert ncurses_termname">ncurses_termname();</dialog>

18329

18330

</function>

18331

18332

<description>Set timeout for special key sequences </description>

18333

<param name="millisec" required="1" vallist="0" default="" type="int">millisec</param>

18334

18335

<insert>ncurses_timeout(int millisec);</insert>

18336

<dialog title="Insert ncurses_timeout">ncurses_timeout(%0);</dialog>

18337

18338

</function>

18339

18340

<description>Specify different filedescriptor for typeahead checking </description>

18341

18342

18343

<insert>ncurses_typeahead(int fd);</insert>

18344

<dialog title="Insert ncurses_typeahead">ncurses_typeahead(%0);</dialog>

18345

18346

</function>

18347

18348

<description>Put a character back into the input stream </description>

18349

<param name="keycode" required="1" vallist="0" default="" type="int">keycode</param>

18350

18351

<insert>ncurses_ungetch(int keycode);</insert>

18352

<dialog title="Insert ncurses_ungetch">ncurses_ungetch(%0);</dialog>

18353

18354

</function>

18355

18356

<description>Pushes mouse event to queue</description>

18357

<param name="mevent" required="1" vallist="0" default="" type="array">mevent</param>

18358

18359

<insert>ncurses_ungetmouse(array mevent);</insert>

18360

<dialog title="Insert ncurses_ungetmouse">ncurses_ungetmouse(%0);</dialog>

18361

18362

</function>

18363

18364

<description>Assign terminal default colors to color id -1 </description>

18365

18366

<insert>ncurses_use_default_colors();</insert>

18367

<dialog title="Insert ncurses_use_default_colors">ncurses_use_default_colors();</dialog>

18368

18369

</function>

18370

18371

<description>Control use of environment information about terminal size </description>

18372

18373

18374

<insert>ncurses_use_env(bool flag);</insert>

18375

<dialog title="Insert ncurses_use_env">ncurses_use_env(%0);</dialog>

18376

18377

</function>

18378

18379

<description>Control use of extended names in terminfo descriptions </description>

18380

18381

18382

<insert>ncurses_use_extended_names(bool flag);</insert>

18383

<dialog title="Insert ncurses_use_extended_names">ncurses_use_extended_names(%0);</dialog>

18384

18385

</function>

18386

18387

<description>Draw a vertical line at current position using an attributed character and max. n characters long </description>

18388

<param name="charattr" required="1" vallist="0" default="" type="int">charattr</param>

18389

18390

18391

<insert>ncurses_vline(int charattr, int n);</insert>

18392

<dialog title="Insert ncurses_vline">ncurses_vline(%0, %1);</dialog>

18393

18394

</function>

18395

18396

<description>Refresh window on terminal screen </description>

18397

<param name="window" required="1" vallist="0" default="" type="resource">window</param>

18398

18399

<insert>ncurses_wrefresh(resource window);</insert>

18400

<dialog title="Insert ncurses_wrefresh">ncurses_wrefresh(%0);</dialog>

18401

18402

</function>

18403

</group>

18404

18405

18406

18407

Check DNS records corresponding to a given Internet host name or

18408

IP address

18409

</description>

18410

18411

18412

18413

<insert>checkdnsrr(string host [,string type]);</insert>

18414

<dialog title="Insert checkdnsrr">checkdnsrr(%0, %1);</dialog>

18415

18416

</function>

18417

18418

<description>Close connection to system logger</description>

18419

18420

<insert>closelog();</insert>

18421

<dialog title="Insert closelog">closelog();</dialog>

18422

18423

</function>

18424

18425

<description>Disable internal PHP debugger (PHP 3)</description>

18426

18427

<insert>debugger_off();</insert>

18428

<dialog title="Insert debugger_off">debugger_off();</dialog>

18429

18430

</function>

18431

18432

<description>Enable internal PHP debugger (PHP 3)</description>

18433

<param name="address" required="1" vallist="0" default="" type="string">address</param>

18434

18435

<insert>debugger_on(string address);</insert>

18436

<dialog title="Insert debugger_on">debugger_on(%0);</dialog>

18437

18438

</function>

18439

18440

<description>Initializes all syslog related constants</description>

18441

18442

<insert>define_syslog_variables();</insert>

18443

<dialog title="Insert define_syslog_variables">define_syslog_variables();</dialog>

18444

18445

</function>

18446

18447

<description>Synonym for </description>

18448

18449

18450

18451

<insert>dns_check_record(string host [,string type]);</insert>

18452

<dialog title="Insert dns_check_record">dns_check_record(%0, %1);</dialog>

18453

18454

</function>

18455

18456

<description>Synonym for </description>

18457

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18458

<param name="mxhosts" required="1" vallist="0" default="" type="array">mxhosts</param>

18459

<param name="&weight" required="0" vallist="0" default="" type="array">&weight</param>

18460

18461

<insert>dns_get_mx(string hostname, array mxhosts [,array &weight]);</insert>

18462

18463

18464

</function>

18465

18466

18467

Fetch DNS Resource Records associated with a hostname

18468

</description>

18469

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18470

18471

<param name="&authns" required="0" vallist="0" default="" type="array">&authns</param>

18472

<param name="&addtl" required="1" vallist="0" default="" type="array">&addtl</param>

18473

<return type="array">array</return>

18474

<insert>dns_get_record(string hostname [,int type] [,array &authns], array &addtl);</insert>

18475

<dialog title="Insert dns_get_record">dns_get_record(%0, %1, %2, %3);</dialog>

18476

18477

</function>

18478

18479

18480

Open Internet or Unix domain socket connection

18481

</description>

18482

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18483

18484

<param name="errno" required="0" vallist="0" default="" type="int">errno</param>

18485

<param name="errstr" required="0" vallist="0" default="" type="string">errstr</param>

18486

<param name="timeout" required="0" vallist="0" default="" type="float">timeout</param>

18487

18488

<insert>fsockopen(string hostname, int port [,int errno] [,string errstr] [,float timeout]);</insert>

18489

<dialog title="Insert fsockopen">fsockopen(%0, %1, %2, %3, %4);</dialog>

18490

18491

</function>

18492

18493

18494

Get the Internet host name corresponding to a given IP address

18495

</description>

18496

<param name="ip_address" required="1" vallist="0" default="" type="string">ip_address</param>

18497

<return type="string">string</return>

18498

<insert>gethostbyaddr(string ip_address);</insert>

18499

<dialog title="Insert gethostbyaddr">gethostbyaddr(%0);</dialog>

18500

18501

</function>

18502

18503

18504

Get the IP address corresponding to a given Internet host name

18505

</description>

18506

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18507

<return type="string">string</return>

18508

<insert>gethostbyname(string hostname);</insert>

18509

<dialog title="Insert gethostbyname">gethostbyname(%0);</dialog>

18510

18511

</function>

18512

18513

18514

Get a list of IP addresses corresponding to a given Internet host

18515

name

18516

</description>

18517

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18518

<return type="array">array</return>

18519

<insert>gethostbynamel(string hostname);</insert>

18520

<dialog title="Insert gethostbynamel">gethostbynamel(%0);</dialog>

18521

18522

</function>

18523

18524

18525

Get MX records corresponding to a given Internet host name

18526

</description>

18527

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18528

<param name="mxhosts" required="1" vallist="0" default="" type="array">mxhosts</param>

18529

<param name="weight" required="0" vallist="0" default="" type="array">weight</param>

18530

18531

<insert>getmxrr(string hostname, array mxhosts [,array weight]);</insert>

18532

<dialog title="Insert getmxrr">getmxrr(%0, %1, %2);</dialog>

18533

18534

</function>

18535

18536

18537

Get protocol number associated with protocol name

18538

</description>

18539

18540

18541

<insert>getprotobyname(string name);</insert>

18542

<dialog title="Insert getprotobyname">getprotobyname(%0);</dialog>

18543

18544

</function>

18545

18546

18547

Get protocol name associated with protocol number

18548

</description>

18549

<param name="number" required="1" vallist="0" default="" type="int">number</param>

18550

<return type="string">string</return>

18551

<insert>getprotobynumber(int number);</insert>

18552

<dialog title="Insert getprotobynumber">getprotobynumber(%0);</dialog>

18553

18554

</function>

18555

18556

18557

Get port number associated with an Internet service and protocol

18558

</description>

18559

<param name="service" required="1" vallist="0" default="" type="string">service</param>

18560

<param name="protocol" required="1" vallist="0" default="" type="string">protocol</param>

18561

18562

<insert>getservbyname(string service, string protocol);</insert>

18563

<dialog title="Insert getservbyname">getservbyname(%0, %1);</dialog>

18564

18565

</function>

18566

18567

18568

Get Internet service which corresponds to port and protocol

18569

</description>

18570

18571

<param name="protocol" required="1" vallist="0" default="" type="string">protocol</param>

18572

<return type="string">string</return>

18573

<insert>getservbyport(int port, string protocol);</insert>

18574

<dialog title="Insert getservbyport">getservbyport(%0, %1);</dialog>

18575

18576

</function>

18577

18578

18579

Converts a string containing an (IPv4) Internet Protocol dotted address

18580

into a proper address.

18581

</description>

18582

<param name="ip_address" required="1" vallist="0" default="" type="string">ip_address</param>

18583

18584

<insert>ip2long(string ip_address);</insert>

18585

18586

18587

</function>

18588

18589

18590

Converts an (IPv4) Internet network address into a string in Internet

18591

standard dotted format

18592

</description>

18593

<param name="proper_address" required="1" vallist="0" default="" type="int">proper_address</param>

18594

<return type="string">string</return>

18595

<insert>long2ip(int proper_address);</insert>

18596

18597

18598

</function>

18599

18600

<description>Open connection to system logger</description>

18601

<param name="ident" required="1" vallist="0" default="" type="string">ident</param>

18602

<param name="option" required="1" vallist="0" default="" type="int">option</param>

18603

<param name="facility" required="1" vallist="0" default="" type="int">facility</param>

18604

18605

<insert>openlog(string ident, int option, int facility);</insert>

18606

<dialog title="Insert openlog">openlog(%0, %1, %2);</dialog>

18607

18608

</function>

18609

18610

18611

Open persistent Internet or Unix domain socket connection

18612

</description>

18613

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

18614

18615

<param name="errno" required="0" vallist="0" default="" type="int">errno</param>

18616

<param name="errstr" required="0" vallist="0" default="" type="string">errstr</param>

18617

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

18618

18619

<insert>pfsockopen(string hostname, int port [,int errno] [,string errstr] [,int timeout]);</insert>

18620

<dialog title="Insert pfsockopen">pfsockopen(%0, %1, %2, %3, %4);</dialog>

18621

18622

</function>

18623

18624

<description>Generate a system log message</description>

18625

<param name="priority" required="1" vallist="0" default="" type="int">priority</param>

18626

<param name="message" required="1" vallist="0" default="" type="string">message</param>

18627

18628

<insert>syslog(int priority, string message);</insert>

18629

<dialog title="Insert syslog">syslog(%0, %1);</dialog>

18630

18631

</function>

18632

</group>

18633

18634

18635

18636

Traverse the map and call a function on each entry

18637

</description>

18638

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18639

18640

<param name="callback" required="1" vallist="0" default="" type="string">callback</param>

18641

18642

<insert>yp_all(string domain, string map, string callback);</insert>

18643

18644

18645

</function>

18646

18647

18648

Return an array containing the entire map

18649

</description>

18650

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18651

18652

<return type="array">array</return>

18653

<insert>yp_cat(string domain, string map);</insert>

18654

18655

18656

</function>

18657

18658

18659

Returns the error string associated with the previous operation

18660

</description>

18661

<return type="string">string</return>

18662

<insert>yp_err_string();</insert>

18663

<dialog title="Insert yp_err_string">yp_err_string();</dialog>

18664

18665

</function>

18666

18667

18668

Returns the error code of the previous operation

18669

</description>

18670

18671

<insert>yp_errno();</insert>

18672

<dialog title="Insert yp_errno">yp_errno();</dialog>

18673

18674

</function>

18675

18676

18677

Returns the first key-value pair from the named map

18678

</description>

18679

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18680

18681

<return type="array">array</return>

18682

<insert>yp_first(string domain, string map);</insert>

18683

<dialog title="Insert yp_first">yp_first(%0, %1);</dialog>

18684

18685

</function>

18686

18687

<description>Fetches the machine's default NIS domain</description>

18688

18689

<insert>yp_get_default_domain();</insert>

18690

<dialog title="Insert yp_get_default_domain">yp_get_default_domain();</dialog>

18691

18692

</function>

18693

18694

18695

Returns the machine name of the master NIS server for a map

18696

</description>

18697

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18698

18699

<return type="string">string</return>

18700

<insert>yp_master(string domain, string map);</insert>

18701

<dialog title="Insert yp_master">yp_master(%0, %1);</dialog>

18702

18703

</function>

18704

18705

<description>Returns the matched line</description>

18706

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18707

18708

18709

<return type="string">string</return>

18710

<insert>yp_match(string domain, string map, string key);</insert>

18711

<dialog title="Insert yp_match">yp_match(%0, %1, %2);</dialog>

18712

18713

</function>

18714

18715

<description>Returns the next key-value pair in the named

18716

map.</description>

18717

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18718

18719

18720

<return type="array">array</return>

18721

<insert>yp_next(string domain, string map, string key);</insert>

18722

18723

18724

</function>

18725

18726

<description>Returns the order number for a map</description>

18727

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

18728

18729

18730

<insert>yp_order(string domain, string map);</insert>

18731

<dialog title="Insert yp_order">yp_order(%0, %1);</dialog>

18732

18733

</function>

18734

</group>

18735

18736

18737

<description>Open the message msg_number in the specified mailbox on the specified server (leave serv</description>

18738

<param name="server" required="1" vallist="0" default="" type="string">server</param>

18739

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

18740

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

18741

<return type="array">array</return>

18742

<insert>notes_body(string server, string mailbox, int msg_number);</insert>

18743

<dialog title="Insert notes_body">notes_body(%0, %1, %2);</dialog>

18744

18745

</function>

18746

18747

<description>Create a note using form form_name </description>

18748

<param name="from_database_name" required="1" vallist="0" default="" type="string">from_database_name</param>

18749

<param name="to_database_name" required="1" vallist="0" default="" type="string">to_database_name</param>

18750

<return type="string">string</return>

18751

<insert>notes_copy_db(string from_database_name, string to_database_name);</insert>

18752

<dialog title="Insert notes_copy_db">notes_copy_db(%0, %1);</dialog>

18753

18754

</function>

18755

18756

<description>Create a Lotus Notes database </description>

18757

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18758

18759

<insert>notes_create_db(string database_name);</insert>

18760

<dialog title="Insert notes_create_db">notes_create_db(%0);</dialog>

18761

18762

</function>

18763

18764

<description>Create a note using form form_name </description>

18765

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18766

18767

<return type="string">string</return>

18768

<insert>notes_create_note(string database_name, string form_name);</insert>

18769

<dialog title="Insert notes_create_note">notes_create_note(%0, %1);</dialog>

18770

18771

</function>

18772

18773

<description>Drop a Lotus Notes database </description>

18774

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18775

18776

<insert>notes_drop_db(string database_name);</insert>

18777

<dialog title="Insert notes_drop_db">notes_drop_db(%0);</dialog>

18778

18779

</function>

18780

18781

<description>Returns a note id found in database_name. Specify the name of the note. Leaving type bla</description>

18782

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18783

18784

18785

18786

<insert>notes_find_note(string database_name, string name [,string type]);</insert>

18787

<dialog title="Insert notes_find_note">notes_find_note(%0, %1, %2);</dialog>

18788

18789

</function>

18790

18791

<description>Open the message msg_number in the specified mailbox on the specified server (leave serv</description>

18792

<param name="server" required="1" vallist="0" default="" type="string">server</param>

18793

<param name="mailbox" required="1" vallist="0" default="" type="string">mailbox</param>

18794

<param name="msg_number" required="1" vallist="0" default="" type="int">msg_number</param>

18795

<return type="object">object</return>

18796

<insert>notes_header_info(string server, string mailbox, int msg_number);</insert>

18797

<dialog title="Insert notes_header_info">notes_header_info(%0, %1, %2);</dialog>

18798

18799

</function>

18800

18801

<description>Returns the notes from a selected database_name</description>

18802

18803

18804

<insert>notes_list_msgs(string db);</insert>

18805

<dialog title="Insert notes_list_msgs">notes_list_msgs(%0);</dialog>

18806

18807

</function>

18808

18809

18810

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18811

18812

18813

<return type="string">string</return>

18814

<insert>notes_mark_read(string database_name, string user_name, string note_id);</insert>

18815

<dialog title="Insert notes_mark_read">notes_mark_read(%0, %1, %2);</dialog>

18816

18817

</function>

18818

18819

<description>Mark a note_id as unread for the User user_name</description>

18820

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18821

18822

18823

<return type="string">string</return>

18824

<insert>notes_mark_unread(string database_name, string user_name, string note_id);</insert>

18825

<dialog title="Insert notes_mark_unread">notes_mark_unread(%0, %1, %2);</dialog>

18826

18827

</function>

18828

18829

<description>Create a navigator name, in database_name </description>

18830

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18831

18832

18833

<insert>notes_nav_create(string database_name, string name);</insert>

18834

<dialog title="Insert notes_nav_create">notes_nav_create(%0, %1);</dialog>

18835

18836

</function>

18837

18838

<description>Find notes that match keywords in database_name</description>

18839

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18840

<param name="keywords" required="1" vallist="0" default="" type="string">keywords</param>

18841

<return type="string">string</return>

18842

<insert>notes_search(string database_name, string keywords);</insert>

18843

<dialog title="Insert notes_search">notes_search(%0, %1);</dialog>

18844

18845

</function>

18846

18847

<description>Returns the unread note id's for the current User user_name</description>

18848

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18849

18850

<return type="string">string</return>

18851

<insert>notes_unread(string database_name, string user_name);</insert>

18852

<dialog title="Insert notes_unread">notes_unread(%0, %1);</dialog>

18853

18854

</function>

18855

18856

<description>Get the version Lotus Notes </description>

18857

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

18858

<return type="string">string</return>

18859

<insert>notes_version(string database_name);</insert>

18860

<dialog title="Insert notes_version">notes_version(%0);</dialog>

18861

18862

</function>

18863

</group>

18864

18865

18866

18867

returns an associative array of the methods and properties from

18868

each class that has been aggregated to the object.

18869

</description>

18870

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18871

<return type="array">array</return>

18872

<insert>aggregate_info(object object);</insert>

18873

<dialog title="Insert aggregate_info">aggregate_info(%0);</dialog>

18874

18875

</function>

18876

18877

18878

selective dynamic class methods aggregation to an object

18879

</description>

18880

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18881

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18882

<param name="methods_list" required="1" vallist="0" default="" type="array">methods_list</param>

18883

<param name="exclude" required="0" vallist="0" default="" type="bool">exclude</param>

18884

18885

<insert>aggregate_methods_by_list(object object, string class_name, array methods_list [,bool exclude]);</insert>

18886

<dialog title="Insert aggregate_methods_by_list">aggregate_methods_by_list(%0, %1, %2, %3);</dialog>

18887

18888

</function>

18889

18890

18891

selective class methods aggregation to an object using a regular

18892

expression

18893

</description>

18894

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18895

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18896

<param name="regexp" required="1" vallist="0" default="" type="string">regexp</param>

18897

<param name="exclude" required="0" vallist="0" default="" type="bool">exclude</param>

18898

18899

<insert>aggregate_methods_by_regexp(object object, string class_name, string regexp [,bool exclude]);</insert>

18900

<dialog title="Insert aggregate_methods_by_regexp">aggregate_methods_by_regexp(%0, %1, %2, %3);</dialog>

18901

18902

</function>

18903

18904

18905

dynamic class and object aggregation of methods

18906

</description>

18907

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18908

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18909

18910

<insert>aggregate_methods(object object, string class_name);</insert>

18911

<dialog title="Insert aggregate_methods">aggregate_methods(%0, %1);</dialog>

18912

18913

</function>

18914

18915

18916

selective dynamic class properties aggregation to an object

18917

</description>

18918

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18919

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18920

<param name="properties_list" required="1" vallist="0" default="" type="array">properties_list</param>

18921

<param name="exclude" required="0" vallist="0" default="" type="bool">exclude</param>

18922

18923

<insert>aggregate_properties_by_list(object object, string class_name, array properties_list [,bool exclude]);</insert>

18924

<dialog title="Insert aggregate_properties_by_list">aggregate_properties_by_list(%0, %1, %2, %3);</dialog>

18925

18926

</function>

18927

18928

18929

selective class properties aggregation to an object using a regular

18930

expression

18931

</description>

18932

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18933

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18934

<param name="regexp" required="1" vallist="0" default="" type="string">regexp</param>

18935

<param name="exclude" required="0" vallist="0" default="" type="bool">exclude</param>

18936

18937

<insert>aggregate_properties_by_regexp(object object, string class_name, string regexp [,bool exclude]);</insert>

18938

<dialog title="Insert aggregate_properties_by_regexp">aggregate_properties_by_regexp(%0, %1, %2, %3);</dialog>

18939

18940

</function>

18941

18942

18943

dynamic aggregation of class properties to an object

18944

</description>

18945

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18946

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18947

18948

<insert>aggregate_properties(object object, string class_name);</insert>

18949

<dialog title="Insert aggregate_properties">aggregate_properties(%0, %1);</dialog>

18950

18951

</function>

18952

18953

18954

dynamic class and object aggregation of methods and properties

18955

</description>

18956

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18957

<param name="class_name" required="1" vallist="0" default="" type="string">class_name</param>

18958

18959

<insert>aggregate(object object, string class_name);</insert>

18960

<dialog title="Insert aggregate">aggregate(%0, %1);</dialog>

18961

18962

</function>

18963

18964

18965

Removes the aggregated methods and properties from an object

18966

</description>

18967

<param name="object" required="1" vallist="0" default="" type="object">object</param>

18968

<param name="class_name" required="0" vallist="0" default="" type="string">class_name</param>

18969

18970

<insert>deaggregate(object object [,string class_name]);</insert>

18971

<dialog title="Insert deaggregate">deaggregate(%0, %1);</dialog>

18972

18973

</function>

18974

</group>

18975

18976

18977

18978

Bind a PHP variable to an Oracle Placeholder

18979

</description>

18980

18981

18982

<param name="variable" required="1" vallist="0" default="" type="mixed &">variable</param>

18983

<param name="length" required="1" vallist="0" default="" type="int">length</param>

18984

<param name="

18985

type" required="0" vallist="0" default="" type="int">

18986

type</param>

18987

18988

<insert>OCIBindByName(int stmt, string ph_name, mixed & variable, int length [,int

18989

type]);</insert>

18990

<dialog title="Insert OCIBindByName">OCIBindByName(%0, %1, %2, %3, %4);</dialog>

18991

18992

</function>

18993

18994

<description>Cancel reading from cursor</description>

18995

18996

18997

<insert>OCICancel(int stmt);</insert>

18998

<dialog title="Insert OCICancel">OCICancel(%0);</dialog>

18999

19000

</function>

19001

19002

<description>Coming soon</description>

19003

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19004

<param name="object" required="1" vallist="0" default="" type="object">object</param>

19005

19006

<insert>ocicollappend(object collection, object object);</insert>

19007

<dialog title="Insert ocicollappend">ocicollappend(%0, %1);</dialog>

19008

19009

</function>

19010

19011

<description>Coming soon</description>

19012

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19013

<param name="object" required="1" vallist="0" default="" type="object">object</param>

19014

19015

<insert>ocicollassign(object collection, object object);</insert>

19016

<dialog title="Insert ocicollassign">ocicollassign(%0, %1);</dialog>

19017

19018

</function>

19019

19020

<description>Coming soon</description>

19021

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19022

19023

19024

19025

<insert>OCICollAssignElem(object collection, string ndx, string val);</insert>

19026

<dialog title="Insert OCICollAssignElem">OCICollAssignElem(%0, %1, %2);</dialog>

19027

19028

</function>

19029

19030

<description>Coming soon</description>

19031

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19032

19033

<return type="string">string</return>

19034

<insert>ocicollgetelem(object collection, string ndx);</insert>

19035

<dialog title="Insert ocicollgetelem">ocicollgetelem(%0, %1);</dialog>

19036

19037

</function>

19038

19039

<description>Coming soon</description>

19040

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19041

19042

<insert>ocicollmax(object collection);</insert>

19043

<dialog title="Insert ocicollmax">ocicollmax(%0);</dialog>

19044

19045

</function>

19046

19047

<description>Coming soon</description>

19048

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19049

19050

<insert>ocicollsize(object collection);</insert>

19051

<dialog title="Insert ocicollsize">ocicollsize(%0);</dialog>

19052

19053

</function>

19054

19055

<description>Coming soon</description>

19056

<param name="collection" required="1" vallist="0" default="" type="object">collection</param>

19057

19058

19059

<insert>ocicolltrim(object collection, int num);</insert>

19060

<dialog title="Insert ocicolltrim">ocicolltrim(%0, %1);</dialog>

19061

19062

</function>

19063

19064

<description>Test whether a result column is </description>

19065

19066

<param name="column" required="1" vallist="0" default="" type="mixed">column</param>

19067

19068

<insert>ocicolumnisnull(resource stmt, mixed column);</insert>

19069

<dialog title="Insert ocicolumnisnull">ocicolumnisnull(%0, %1);</dialog>

19070

19071

</function>

19072

19073

<description>Returns the name of a column</description>

19074

19075

19076

<return type="string">string</return>

19077

<insert>ocicolumnname(int stmt, int col);</insert>

19078

<dialog title="Insert ocicolumnname">ocicolumnname(%0, %1);</dialog>

19079

19080

</function>

19081

19082

<description>Coming soon</description>

19083

19084

19085

19086

<insert>ocicolumnprecision(int stmt, int col);</insert>

19087

<dialog title="Insert ocicolumnprecision">ocicolumnprecision(%0, %1);</dialog>

19088

19089

</function>

19090

19091

<description>Coming soon</description>

19092

19093

19094

19095

<insert>ocicolumnscale(int stmt, int col);</insert>

19096

<dialog title="Insert ocicolumnscale">ocicolumnscale(%0, %1);</dialog>

19097

19098

</function>

19099

19100

<description>Return result column size</description>

19101

19102

<param name="column" required="1" vallist="0" default="" type="mixed">column</param>

19103

19104

<insert>ocicolumnsize(int stmt, mixed column);</insert>

19105

<dialog title="Insert ocicolumnsize">ocicolumnsize(%0, %1);</dialog>

19106

19107

</function>

19108

19109

<description>Returns the data type of a column</description>

19110

19111

19112

<return type="mixed">mixed</return>

19113

<insert>ocicolumntype(int stmt, int col);</insert>

19114

<dialog title="Insert ocicolumntype">ocicolumntype(%0, %1);</dialog>

19115

19116

</function>

19117

19118

<description>Coming soon</description>

19119

19120

19121

<return type="mixed">mixed</return>

19122

<insert>ocicolumntyperaw(int stmt, int col);</insert>

19123

<dialog title="Insert ocicolumntyperaw">ocicolumntyperaw(%0, %1);</dialog>

19124

19125

</function>

19126

19127

<description>Commits outstanding transactions</description>

19128

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

19129

19130

<insert>OCICommit(int connection);</insert>

19131

<dialog title="Insert OCICommit">OCICommit(%0);</dialog>

19132

19133

</function>

19134

19135

19136

Use a PHP variable for the define-step during a SELECT

19137

</description>

19138

19139

<param name="Column-Name" required="1" vallist="0" default="" type="string">Column-Name</param>

19140

<param name="variable" required="1" vallist="0" default="" type="mixed">variable</param>

19141

19142

19143

<insert>OCIDefineByName(int stmt, string Column-Name, mixed variable [,int type]);</insert>

19144

<dialog title="Insert OCIDefineByName">OCIDefineByName(%0, %1, %2, %3);</dialog>

19145

19146

</function>

19147

19148

<description>Return the last error of stmt|conn|global</description>

19149

<param name="stmt|conn|global" required="0" vallist="0" default="" type="int">stmt|conn|global</param>

19150

<return type="array">array</return>

19151

<insert>OCIError([int stmt|conn|global]);</insert>

19152

<dialog title="Insert OCIError">OCIError(%0);</dialog>

19153

19154

</function>

19155

19156

<description>Execute a statement</description>

19157

<param name="statement" required="1" vallist="0" default="" type="int">statement</param>

19158

19159

19160

<insert>ociexecute(int statement [,int mode]);</insert>

19161

<dialog title="Insert ociexecute">ociexecute(%0, %1);</dialog>

19162

19163

</function>

19164

19165

<description>Fetches the next row into result-buffer</description>

19166

<param name="statement" required="1" vallist="0" default="" type="int">statement</param>

19167

19168

<insert>ocifetch(int statement);</insert>

19169

<dialog title="Insert ocifetch">ocifetch(%0);</dialog>

19170

19171

</function>

19172

19173

<description>Fetches the next row into result-array</description>

19174

19175

<param name="&result" required="1" vallist="0" default="" type="array">&result</param>

19176

19177

19178

<insert>ocifetchinto(int stmt, array &result [,int mode]);</insert>

19179

<dialog title="Insert ocifetchinto">ocifetchinto(%0, %1, %2);</dialog>

19180

19181

</function>

19182

19183

<description>Fetch all rows of result data into an array</description>

19184

19185

<param name="variable" required="1" vallist="0" default="" type="array &">variable</param>

19186

19187

<insert>ocifetchstatement(resource stmt, array & variable);</insert>

19188

<dialog title="Insert ocifetchstatement">ocifetchstatement(%0, %1);</dialog>

19189

19190

</function>

19191

19192

<description>Coming soon</description>

19193

19194

19195

<insert>ocifreecollection(object lob);</insert>

19196

<dialog title="Insert ocifreecollection">ocifreecollection(%0);</dialog>

19197

19198

</function>

19199

19200

19201

Free all resources associated with a cursor

19202

</description>

19203

19204

19205

<insert>ocifreecursor(int stmt);</insert>

19206

<dialog title="Insert ocifreecursor">ocifreecursor(%0);</dialog>

19207

19208

</function>

19209

19210

<description>Deletes a large object descriptor</description>

19211

19212

19213

<insert>ocifreedesc(object lob);</insert>

19214

<dialog title="Insert ocifreedesc">ocifreedesc(%0);</dialog>

19215

19216

</function>

19217

19218

19219

Free all resources associated with a statement

19220

</description>

19221

19222

19223

<insert>ocifreestatement(resource stmt);</insert>

19224

<dialog title="Insert ocifreestatement">ocifreestatement(%0);</dialog>

19225

19226

</function>

19227

19228

19229

Enables or disables internal debug output

19230

</description>

19231

<param name="onoff" required="1" vallist="0" default="" type="int">onoff</param>

19232

19233

<insert>ociinternaldebug(int onoff);</insert>

19234

<dialog title="Insert ociinternaldebug">ociinternaldebug(%0);</dialog>

19235

19236

</function>

19237

19238

<description>Coming soon</description>

19239

19240

<return type="string">string</return>

19241

<insert>ociloadlob(object lob);</insert>

19242

<dialog title="Insert ociloadlob">ociloadlob(%0);</dialog>

19243

19244

</function>

19245

19246

<description>Disconnects from Oracle server</description>

19247

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

19248

19249

<insert>ocilogoff(resource connection);</insert>

19250

<dialog title="Insert ocilogoff">ocilogoff(%0);</dialog>

19251

19252

</function>

19253

19254

<description>Establishes a connection to Oracle</description>

19255

<param name="username" required="1" vallist="0" default="" type="string">username</param>

19256

<param name="password" required="1" vallist="0" default="" type="string">password</param>

19257

19258

19259

<insert>ocilogon(string username, string password [,string db]);</insert>

19260

<dialog title="Insert ocilogon">ocilogon(%0, %1, %2);</dialog>

19261

19262

</function>

19263

19264

<description>Coming soon</description>

19265

19266

19267

<param name="shema" required="0" vallist="0" default="" type="string">shema</param>

19268

19269

<insert>ocinewcollection(int conn, string tdo [,string shema]);</insert>

19270

<dialog title="Insert ocinewcollection">ocinewcollection(%0, %1, %2);</dialog>

19271

19272

</function>

19273

19274

19275

Return a new cursor (Statement-Handle)

19276

</description>

19277

19278

<return type="resource">resource</return>

19279

<insert>ocinewcursor(resource conn);</insert>

19280

<dialog title="Insert ocinewcursor">ocinewcursor(%0);</dialog>

19281

19282

</function>

19283

19284

19285

Initialize a new empty LOB or FILE descriptor

19286

</description>

19287

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

19288

19289

<return type="string">string</return>

19290

<insert>ocinewdescriptor(int connection [,int type]);</insert>

19291

<dialog title="Insert ocinewdescriptor">ocinewdescriptor(%0, %1);</dialog>

19292

19293

</function>

19294

19295

<description>Establishes a new connection to Oracle</description>

19296

<param name="username" required="1" vallist="0" default="" type="string">username</param>

19297

<param name="password" required="1" vallist="0" default="" type="string">password</param>

19298

19299

19300

<insert>ocinlogon(string username, string password [,string db]);</insert>

19301

<dialog title="Insert ocinlogon">ocinlogon(%0, %1, %2);</dialog>

19302

19303

</function>

19304

19305

19306

Return the number of result columns in a statement

19307

</description>

19308

19309

19310

<insert>ocinumcols(resource stmt);</insert>

19311

<dialog title="Insert ocinumcols">ocinumcols(%0);</dialog>

19312

19313

</function>

19314

19315

<description>Parse a query and return an Oracle statement</description>

19316

19317

<param name="query" required="1" vallist="0" default="" type="string">query</param>

19318

19319

<insert>ociparse(int conn, string query);</insert>

19320

<dialog title="Insert ociparse">ociparse(%0, %1);</dialog>

19321

19322

</function>

19323

19324

19325

Connect to an Oracle database using a persistent connection

19326

</description>

19327

<param name="username" required="1" vallist="0" default="" type="string">username</param>

19328

<param name="password" required="1" vallist="0" default="" type="string">password</param>

19329

19330

19331

<insert>ociplogon(string username, string password [,string db]);</insert>

19332

<dialog title="Insert ociplogon">ociplogon(%0, %1, %2);</dialog>

19333

19334

</function>

19335

19336

<description>Returns column value for fetched row</description>

19337

<param name="statement" required="1" vallist="0" default="" type="int">statement</param>

19338

<param name="column" required="1" vallist="0" default="" type="mixed">column</param>

19339

<return type="mixed">mixed</return>

19340

<insert>ociresult(int statement, mixed column);</insert>

19341

<dialog title="Insert ociresult">ociresult(%0, %1);</dialog>

19342

19343

</function>

19344

19345

<description>Rolls back outstanding transactions</description>

19346

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

19347

19348

<insert>ocirollback(resource connection);</insert>

19349

<dialog title="Insert ocirollback">ocirollback(%0);</dialog>

19350

19351

</function>

19352

19353

<description>Gets the number of affected rows</description>

19354

<param name="statement" required="1" vallist="0" default="" type="resource">statement</param>

19355

19356

<insert>ocirowcount(resource statement);</insert>

19357

<dialog title="Insert ocirowcount">ocirowcount(%0);</dialog>

19358

19359

</function>

19360

19361

<description>Coming soon</description>

19362

19363

19364

<insert>ocisavelob(object lob);</insert>

19365

<dialog title="Insert ocisavelob">ocisavelob(%0);</dialog>

19366

19367

</function>

19368

19369

<description>Coming soon</description>

19370

19371

19372

<insert>ocisavelobfile(object lob);</insert>

19373

<dialog title="Insert ocisavelobfile">ocisavelobfile(%0);</dialog>

19374

19375

</function>

19376

19377

<description>Return a string containing server version

19378

information</description>

19379

19380

<return type="string">string</return>

19381

<insert>ociserverversion(resource conn);</insert>

19382

<dialog title="Insert ociserverversion">ociserverversion(%0);</dialog>

19383

19384

</function>

19385

19386

<description>Sets number of rows to be prefetched</description>

19387

19388

19389

19390

<insert>ocisetprefetch(resource stmt, int rows);</insert>

19391

<dialog title="Insert ocisetprefetch">ocisetprefetch(%0, %1);</dialog>

19392

19393

</function>

19394

19395

<description>Return the type of an OCI statement</description>

19396

19397

<return type="string">string</return>

19398

<insert>ocistatementtype(resource stmt);</insert>

19399

<dialog title="Insert ocistatementtype">ocistatementtype(%0);</dialog>

19400

19401

</function>

19402

19403

<description>Coming soon</description>

19404

19405

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

19406

<param name="start" required="0" vallist="0" default="" type="int">start</param>

19407

<param name="lenght" required="0" vallist="0" default="" type="int">lenght</param>

19408

19409

<insert>ociwritelobtofile(object lob [,string filename] [,int start] [,int lenght]);</insert>

19410

<dialog title="Insert ociwritelobtofile">ociwritelobtofile(%0, %1, %2, %3);</dialog>

19411

19412

</function>

19413

</group>

19414

19415

19416

<description>Exports a CSR to a file</description>

19417

19418

<param name="outfilename" required="1" vallist="0" default="" type="string">outfilename</param>

19419

<param name="notext" required="0" vallist="0" default="" type="bool">notext</param>

19420

19421

<insert>openssl_csr_export_to_file(resource csr, string outfilename [,bool notext]);</insert>

19422

<dialog title="Insert openssl_csr_export_to_file">openssl_csr_export_to_file(%0, %1, %2);</dialog>

19423

19424

</function>

19425

19426

<description>Exports a CSR as a string</description>

19427

19428

19429

<param name="notext" required="0" vallist="0" default="" type="bool">notext</param>

19430

19431

<insert>openssl_csr_export(resource csr, string &out [,bool notext]);</insert>

19432

<dialog title="Insert openssl_csr_export">openssl_csr_export(%0, %1, %2);</dialog>

19433

19434

</function>

19435

19436

<description>Generates a CSR</description>

19437

19438

<param name="privkey" required="1" vallist="0" default="" type="resource">privkey</param>

19439

<param name="configargs" required="0" vallist="0" default="" type="array">configargs</param>

19440

<param name="extraattribs" required="0" vallist="0" default="" type="array">extraattribs</param>

19441

19442

<insert>openssl_csr_new(array dn, resource privkey [,array configargs] [,array extraattribs]);</insert>

19443

<dialog title="Insert openssl_csr_new">openssl_csr_new(%0, %1, %2, %3);</dialog>

19444

19445

</function>

19446

19447

<description>Sign a CSR with another certificate (or itself) and generate a certificate</description>

19448

19449

<param name="cacert" required="1" vallist="0" default="" type="mixed">cacert</param>

19450

19451

19452

<return type="resource">resource</return>

19453

<insert>openssl_csr_sign(mixed csr, mixed cacert, mixed priv_key, long days);</insert>

19454

<dialog title="Insert openssl_csr_sign">openssl_csr_sign(%0, %1, %2, %3);</dialog>

19455

19456

</function>

19457

19458

<description>Return openSSL error message</description>

19459

<return type="mixed">mixed</return>

19460

<insert>openssl_error_string();</insert>

19461

<dialog title="Insert openssl_error_string">openssl_error_string();</dialog>

19462

19463

</function>

19464

19465

<description>Free key resource</description>

19466

<param name="key_identifier" required="1" vallist="0" default="" type="resource">key_identifier</param>

19467

19468

<insert>openssl_free_key(resource key_identifier);</insert>

19469

<dialog title="Insert openssl_free_key">openssl_free_key(%0);</dialog>

19470

19471

</function>

19472

19473

<description>Get a private key</description>

19474

19475

<param name="passphrase" required="0" vallist="0" default="" type="string">passphrase</param>

19476

<return type="resource">resource</return>

19477

<insert>openssl_get_privatekey(mixed key [,string passphrase]);</insert>

19478

<dialog title="Insert openssl_get_privatekey">openssl_get_privatekey(%0, %1);</dialog>

19479

19480

</function>

19481

19482

<description>Extract public key from certificate and prepare it for use</description>

19483

<param name="certificate" required="1" vallist="0" default="" type="mixed">certificate</param>

19484

<return type="resource">resource</return>

19485

<insert>openssl_get_publickey(mixed certificate);</insert>

19486

<dialog title="Insert openssl_get_publickey">openssl_get_publickey(%0);</dialog>

19487

19488

</function>

19489

19490

<description>Open sealed data</description>

19491

<param name="sealed_data" required="1" vallist="0" default="" type="string">sealed_data</param>

19492

19493

19494

19495

19496

<insert>openssl_open(string sealed_data, string open_data, string env_key, mixed priv_key_id);</insert>

19497

<dialog title="Insert openssl_open">openssl_open(%0, %1, %2, %3);</dialog>

19498

19499

</function>

19500

19501

<description>Decrypts an S/MIME encrypted message</description>

19502

<param name="infilename" required="1" vallist="0" default="" type="string">infilename</param>

19503

<param name="outfilename" required="1" vallist="0" default="" type="string">outfilename</param>

19504

<param name="recipcert" required="1" vallist="0" default="" type="mixed">recipcert</param>

19505

<param name="recipkey" required="0" vallist="0" default="" type="mixed">recipkey</param>

19506

19507

<insert>openssl_pkcs7_decrypt(string infilename, string outfilename, mixed recipcert [,mixed recipkey]);</insert>

19508

<dialog title="Insert openssl_pkcs7_decrypt">openssl_pkcs7_decrypt(%0, %1, %2, %3);</dialog>

19509

19510

</function>

19511

19512

<description>Encrypt an S/MIME message</description>

19513

<param name="infile" required="1" vallist="0" default="" type="string">infile</param>

19514

<param name="outfile" required="1" vallist="0" default="" type="string">outfile</param>

19515

<param name="recipcerts" required="1" vallist="0" default="" type="mixed">recipcerts</param>

19516

<param name="headers" required="1" vallist="0" default="" type="array">headers</param>

19517

<param name="flags" required="0" vallist="0" default="" type="long">flags</param>

19518

19519

<insert>openssl_pkcs7_encrypt(string infile, string outfile, mixed recipcerts, array headers [,long flags]);</insert>

19520

<dialog title="Insert openssl_pkcs7_encrypt">openssl_pkcs7_encrypt(%0, %1, %2, %3, %4);</dialog>

19521

19522

</function>

19523

19524

<description>sign an S/MIME message</description>

19525

<param name="infilename" required="1" vallist="0" default="" type="string">infilename</param>

19526

<param name="outfilename" required="1" vallist="0" default="" type="string">outfilename</param>

19527

<param name="signcert" required="1" vallist="0" default="" type="mixed">signcert</param>

19528

<param name="privkey" required="1" vallist="0" default="" type="mixed">privkey</param>

19529

<param name="headers" required="1" vallist="0" default="" type="array">headers</param>

19530

<param name="flags" required="0" vallist="0" default="" type="long">flags</param>

19531

<param name="extracertsfilename" required="0" vallist="0" default="" type="string">extracertsfilename</param>

19532

19533

<insert>openssl_pkcs7_sign(string infilename, string outfilename, mixed signcert, mixed privkey, array headers [,long flags] [,string extracertsfilename]);</insert>

19534

<dialog title="Insert openssl_pkcs7_sign">openssl_pkcs7_sign(%0, %1, %2, %3, %4, %5, %6);</dialog>

19535

19536

</function>

19537

19538

<description>Verifies the signature of an S/MIME signed message</description>

19539

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

19540

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

19541

<param name="outfilename" required="0" vallist="0" default="" type="string">outfilename</param>

19542

<param name="cainfo" required="0" vallist="0" default="" type="array">cainfo</param>

19543

<param name="extracerts" required="0" vallist="0" default="" type="string">extracerts</param>

19544

19545

<insert>openssl_pkcs7_verify(string filename, int flags [,string outfilename] [,array cainfo] [,string extracerts]);</insert>

19546

<dialog title="Insert openssl_pkcs7_verify">openssl_pkcs7_verify(%0, %1, %2, %3, %4);</dialog>

19547

19548

</function>

19549

19550

<description>Gets an exportable representation of a key into a file </description>

19551

19552

<param name="outfilename" required="1" vallist="0" default="" type="string">outfilename</param>

19553

<param name="passphrase" required="0" vallist="0" default="" type="string">passphrase</param>

19554

<param name="configargs" required="0" vallist="0" default="" type="array">configargs</param>

19555

19556

<insert>openssl_pkey_export_to_file(mixed key, string outfilename [,string passphrase] [,array configargs]);</insert>

19557

<dialog title="Insert openssl_pkey_export_to_file">openssl_pkey_export_to_file(%0, %1, %2, %3);</dialog>

19558

19559

</function>

19560

19561

<description>Gets an exportable representation of a key into a string</description>

19562

19563

19564

<param name="passphrase" required="0" vallist="0" default="" type="string">passphrase</param>

19565

<param name="configargs" required="0" vallist="0" default="" type="array">configargs</param>

19566

19567

<insert>openssl_pkey_export(mixed key, string &out [,string passphrase] [,array configargs]);</insert>

19568

<dialog title="Insert openssl_pkey_export">openssl_pkey_export(%0, %1, %2, %3);</dialog>

19569

19570

</function>

19571

19572

<description>Get a private key</description>

19573

19574

<param name="passphrase" required="0" vallist="0" default="" type="string">passphrase</param>

19575

<return type="resource">resource</return>

19576

<insert>openssl_pkey_get_private(mixed key [,string passphrase]);</insert>

19577

<dialog title="Insert openssl_pkey_get_private">openssl_pkey_get_private(%0, %1);</dialog>

19578

19579

</function>

19580

19581

<description>Extract public key from certificate and prepare it for use</description>

19582

<param name="certificate" required="1" vallist="0" default="" type="mixed">certificate</param>

19583

<return type="resource">resource</return>

19584

<insert>openssl_pkey_get_public(mixed certificate);</insert>

19585

<dialog title="Insert openssl_pkey_get_public">openssl_pkey_get_public(%0);</dialog>

19586

19587

</function>

19588

19589

<description>Generates a new private key </description>

19590

<param name="configargs" required="0" vallist="0" default="" type="array">configargs</param>

19591

<return type="resource">resource</return>

19592

<insert>openssl_pkey_new([array configargs]);</insert>

19593

<dialog title="Insert openssl_pkey_new">openssl_pkey_new(%0);</dialog>

19594

19595

</function>

19596

19597

<description>Decrypts data with private key </description>

19598

19599

<param name="&decrypted" required="1" vallist="0" default="" type="string">&decrypted</param>

19600

19601

<param name="padding" required="0" vallist="0" default="" type="int">padding</param>

19602

19603

<insert>openssl_private_decrypt(string data, string &decrypted, mixed key [,int padding]);</insert>

19604

<dialog title="Insert openssl_private_decrypt">openssl_private_decrypt(%0, %1, %2, %3);</dialog>

19605

19606

</function>

19607

19608

<description>Encrypts data with private key </description>

19609

19610

<param name="crypted" required="1" vallist="0" default="" type="string">crypted</param>

19611

19612

<param name="padding" required="0" vallist="0" default="" type="int">padding</param>

19613

19614

<insert>openssl_private_encrypt(string data, string crypted, mixed key [,int padding]);</insert>

19615

<dialog title="Insert openssl_private_encrypt">openssl_private_encrypt(%0, %1, %2, %3);</dialog>

19616

19617

</function>

19618

19619

<description>Decrypts data with public key </description>

19620

19621

<param name="crypted" required="1" vallist="0" default="" type="string">crypted</param>

19622

19623

<param name="padding" required="0" vallist="0" default="" type="int">padding</param>

19624

19625

<insert>openssl_public_decrypt(string data, string crypted, resource key [,int padding]);</insert>

19626

<dialog title="Insert openssl_public_decrypt">openssl_public_decrypt(%0, %1, %2, %3);</dialog>

19627

19628

</function>

19629

19630

<description>Encrypts data with public key </description>

19631

19632

<param name="crypted" required="1" vallist="0" default="" type="string">crypted</param>

19633

19634

<param name="padding" required="0" vallist="0" default="" type="int">padding</param>

19635

19636

<insert>openssl_public_encrypt(string data, string crypted, mixed key [,int padding]);</insert>

19637

<dialog title="Insert openssl_public_encrypt">openssl_public_encrypt(%0, %1, %2, %3);</dialog>

19638

19639

</function>

19640

19641

<description>Seal (encrypt) data</description>

19642

19643

<param name="sealed_data" required="1" vallist="0" default="" type="string">sealed_data</param>

19644

19645

19646

19647

<insert>openssl_seal(string data, string sealed_data, array env_keys, array pub_key_ids);</insert>

19648

<dialog title="Insert openssl_seal">openssl_seal(%0, %1, %2, %3);</dialog>

19649

19650

</function>

19651

19652

<description>Generate signature</description>

19653

19654

<param name="signature" required="1" vallist="0" default="" type="string">signature</param>

19655

19656

19657

<insert>openssl_sign(string data, string signature, mixed priv_key_id);</insert>

19658

<dialog title="Insert openssl_sign">openssl_sign(%0, %1, %2);</dialog>

19659

19660

</function>

19661

19662

<description>Verify signature</description>

19663

19664

<param name="signature" required="1" vallist="0" default="" type="string">signature</param>

19665

19666

19667

<insert>openssl_verify(string data, string signature, mixed pub_key_id);</insert>

19668

<dialog title="Insert openssl_verify">openssl_verify(%0, %1, %2);</dialog>

19669

19670

</function>

19671

19672

<description>Checks if a private key corresponds to a certificate</description>

19673

19674

19675

19676

<insert>openssl_x509_check_private_key(mixed cert, mixed key);</insert>

19677

<dialog title="Insert openssl_x509_check_private_key">openssl_x509_check_private_key(%0, %1);</dialog>

19678

19679

</function>

19680

19681

<description>Verifies if a certificate can be used for a particular

19682

purpose</description>

19683

19684

<param name="purpose" required="1" vallist="0" default="" type="int">purpose</param>

19685

<param name="cainfo" required="1" vallist="0" default="" type="array">cainfo</param>

19686

<param name="untrustedfile" required="0" vallist="0" default="" type="string">untrustedfile</param>

19687

19688

<insert>openssl_x509_checkpurpose(mixed x509cert, int purpose, array cainfo [,string untrustedfile]);</insert>

19689

<dialog title="Insert openssl_x509_checkpurpose">openssl_x509_checkpurpose(%0, %1, %2, %3);</dialog>

19690

19691

</function>

19692

19693

<description>Exports a certificate to file</description>

19694

19695

<param name="outfilename" required="1" vallist="0" default="" type="string">outfilename</param>

19696

<param name="notext" required="0" vallist="0" default="" type="bool">notext</param>

19697

19698

<insert>openssl_x509_export_to_file(mixed x509, string outfilename [,bool notext]);</insert>

19699

<dialog title="Insert openssl_x509_export_to_file">openssl_x509_export_to_file(%0, %1, %2);</dialog>

19700

19701

</function>

19702

19703

<description>Exports a certificate as a string</description>

19704

19705

<param name="&output" required="1" vallist="0" default="" type="string">&output</param>

19706

<param name="notext" required="0" vallist="0" default="" type="bool">notext</param>

19707

19708

<insert>openssl_x509_export(mixed x509, string &output [,bool notext]);</insert>

19709

<dialog title="Insert openssl_x509_export">openssl_x509_export(%0, %1, %2);</dialog>

19710

19711

</function>

19712

19713

<description>Free certificate resource</description>

19714

19715

19716

<insert>openssl_x509_free(resource x509cert);</insert>

19717

<dialog title="Insert openssl_x509_free">openssl_x509_free(%0);</dialog>

19718

19719

</function>

19720

19721

<description>Parse an X509 certificate and return the information as an

19722

array</description>

19723

19724

<param name="shortnames" required="0" vallist="0" default="" type="bool">shortnames</param>

19725

<return type="array">array</return>

19726

<insert>openssl_x509_parse(mixed x509cert [,bool shortnames]);</insert>

19727

<dialog title="Insert openssl_x509_parse">openssl_x509_parse(%0, %1);</dialog>

19728

19729

</function>

19730

19731

<description>Parse an X.509 certificate and return a resource identifier for

19732

it</description>

19733

<param name="x509certdata" required="1" vallist="0" default="" type="mixed">x509certdata</param>

19734

<return type="resource">resource</return>

19735

<insert>openssl_x509_read(mixed x509certdata);</insert>

19736

<dialog title="Insert openssl_x509_read">openssl_x509_read(%0);</dialog>

19737

19738

</function>

19739

</group>

19740

19741

19742

<description>bind a PHP variable to an Oracle parameter</description>

19743

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19744

<param name="PHP variable name" required="1" vallist="0" default="" type="string">PHP variable name</param>

19745

<param name="SQL parameter name" required="1" vallist="0" default="" type="string">SQL parameter name</param>

19746

<param name="length" required="1" vallist="0" default="" type="int">length</param>

19747

19748

19749

<insert>Ora_Bind(int cursor, string PHP variable name, string SQL parameter name, int length [,int type]);</insert>

19750

19751

19752

</function>

19753

19754

<description>close an Oracle cursor</description>

19755

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19756

19757

<insert>Ora_Close(int cursor);</insert>

19758

<dialog title="Insert Ora_Close">Ora_Close(%0);</dialog>

19759

19760

</function>

19761

19762

<description>Get name of Oracle result column</description>

19763

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19764

<param name="column" required="1" vallist="0" default="" type="int">column</param>

19765

<return type="string">string</return>

19766

<insert>ora_columnname(int cursor, int column);</insert>

19767

<dialog title="Insert ora_columnname">ora_columnname(%0, %1);</dialog>

19768

19769

</function>

19770

19771

<description>get size of Oracle result column</description>

19772

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19773

<param name="column" required="1" vallist="0" default="" type="int">column</param>

19774

19775

<insert>ora_columnsize(int cursor, int column);</insert>

19776

<dialog title="Insert ora_columnsize">ora_columnsize(%0, %1);</dialog>

19777

19778

</function>

19779

19780

<description>Get type of Oracle result column</description>

19781

<param name="cursor" required="1" vallist="0" default="" type="resource">cursor</param>

19782

<param name="column" required="1" vallist="0" default="" type="int">column</param>

19783

<return type="string">string</return>

19784

<insert>ora_columntype(resource cursor, int column);</insert>

19785

<dialog title="Insert ora_columntype">ora_columntype(%0, %1);</dialog>

19786

19787

</function>

19788

19789

<description>commit an Oracle transaction</description>

19790

19791

19792

<insert>ora_commit(int conn);</insert>

19793

<dialog title="Insert ora_commit">ora_commit(%0);</dialog>

19794

19795

</function>

19796

19797

<description>disable automatic commit</description>

19798

19799

19800

<insert>ora_commitoff(int conn);</insert>

19801

<dialog title="Insert ora_commitoff">ora_commitoff(%0);</dialog>

19802

19803

</function>

19804

19805

<description>enable automatic commit</description>

19806

19807

19808

<insert>Ora_CommitOn(int conn);</insert>

19809

<dialog title="Insert Ora_CommitOn">Ora_CommitOn(%0);</dialog>

19810

19811

</function>

19812

19813

<description>Parse, Exec, Fetch</description>

19814

19815

<param name="query" required="1" vallist="0" default="" type="string">query</param>

19816

19817

<insert>Ora_Do(int conn, string query);</insert>

19818

19819

19820

</function>

19821

19822

<description>get Oracle error message</description>

19823

<param name="cursor_or_connection" required="1" vallist="0" default="" type="int">cursor_or_connection</param>

19824

<return type="string">string</return>

19825

<insert>ora_error(int cursor_or_connection);</insert>

19826

<dialog title="Insert ora_error">ora_error(%0);</dialog>

19827

19828

</function>

19829

19830

<description>get Oracle error code</description>

19831

<param name="cursor_or_connection" required="1" vallist="0" default="" type="int">cursor_or_connection</param>

19832

19833

<insert>ora_errorcode(int cursor_or_connection);</insert>

19834

<dialog title="Insert ora_errorcode">ora_errorcode(%0);</dialog>

19835

19836

</function>

19837

19838

<description>Execute parsed statement on an Oracle cursor</description>

19839

<param name="cursor" required="1" vallist="0" default="" type="resource">cursor</param>

19840

19841

<insert>ora_exec(resource cursor);</insert>

19842

19843

19844

</function>

19845

19846

<description>Fetch a row into the specified result array</description>

19847

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19848

<param name="result" required="1" vallist="0" default="" type="array">result</param>

19849

<param name="

19850

flags

19851

" required="0" vallist="0" default="" type="int">

19852

flags

19853

</param>

19854

19855

<insert>Ora_Fetch_Into(int cursor, array result [,int

19856

flags

19857

]);</insert>

19858

<dialog title="Insert Ora_Fetch_Into">Ora_Fetch_Into(%0, %1, %2);</dialog>

19859

19860

</function>

19861

19862

<description>fetch a row of data from a cursor</description>

19863

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19864

19865

<insert>Ora_Fetch(int cursor);</insert>

19866

<dialog title="Insert Ora_Fetch">Ora_Fetch(%0);</dialog>

19867

19868

</function>

19869

19870

<description>Get data from a fetched column</description>

19871

<param name="cursor" required="1" vallist="0" default="" type="int">cursor</param>

19872

<param name="column" required="1" vallist="0" default="" type="mixed">column</param>

19873

<return type="mixed">mixed</return>

19874

<insert>ora_getcolumn(int cursor, mixed column);</insert>

19875

<dialog title="Insert ora_getcolumn">ora_getcolumn(%0, %1);</dialog>

19876

19877

</function>

19878

19879

<description>Close an Oracle connection</description>

19880

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

19881

19882

<insert>ora_logoff(int connection);</insert>

19883

<dialog title="Insert ora_logoff">ora_logoff(%0);</dialog>

19884

19885

</function>

19886

19887

<description>Open an Oracle connection</description>

19888

19889

<param name="password" required="1" vallist="0" default="" type="string">password</param>

19890

<return type="resource">resource</return>

19891

<insert>ora_logon(string user, string password);</insert>

19892

<dialog title="Insert ora_logon">ora_logon(%0, %1);</dialog>

19893

19894

</function>

19895

19896

<description>Returns the number of columns</description>

19897

<param name="cursor_ind" required="1" vallist="0" default="" type="int">cursor_ind</param>

19898

19899

<insert>ora_numcols(int cursor_ind);</insert>

19900

<dialog title="Insert ora_numcols">ora_numcols(%0);</dialog>

19901

19902

</function>

19903

19904

<description>Returns the number of rows</description>

19905

<param name="cursor_ind" required="1" vallist="0" default="" type="int">cursor_ind</param>

19906

19907

<insert>ora_numrows(int cursor_ind);</insert>

19908

<dialog title="Insert ora_numrows">ora_numrows(%0);</dialog>

19909

19910

</function>

19911

19912

<description>open an Oracle cursor</description>

19913

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

19914

19915

<insert>ora_open(int connection);</insert>

19916

19917

19918

</function>

19919

19920

<description>Parse an SQL statement with Oracle</description>

19921

<param name="cursor_ind" required="1" vallist="0" default="" type="int">cursor_ind</param>

19922

<param name="sql_statement" required="1" vallist="0" default="" type="string">sql_statement</param>

19923

<param name="defer" required="1" vallist="0" default="" type="int">defer</param>

19924

19925

<insert>ora_parse(int cursor_ind, string sql_statement, int defer);</insert>

19926

<dialog title="Insert ora_parse">ora_parse(%0, %1, %2);</dialog>

19927

19928

</function>

19929

19930

19931

Open a persistent Oracle connection

19932

</description>

19933

19934

<param name="password" required="1" vallist="0" default="" type="string">password</param>

19935

19936

<insert>ora_plogon(string user, string password);</insert>

19937

<dialog title="Insert ora_plogon">ora_plogon(%0, %1);</dialog>

19938

19939

</function>

19940

19941

<description>roll back transaction</description>

19942

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

19943

19944

<insert>Ora_Rollback(int connection);</insert>

19945

<dialog title="Insert Ora_Rollback">Ora_Rollback(%0);</dialog>

19946

19947

</function>

19948

</group>

19949

19950

19951

<description>Flush the output buffer</description>

19952

19953

<insert>flush();</insert>

19954

<dialog title="Insert flush">flush();</dialog>

19955

19956

</function>

19957

19958

19959

Clean (erase) the output buffer

19960

</description>

19961

19962

<insert>ob_clean();</insert>

19963

<dialog title="Insert ob_clean">ob_clean();</dialog>

19964

19965

</function>

19966

19967

19968

Clean (erase) the output buffer and turn off output buffering

19969

</description>

19970

19971

<insert>ob_end_clean();</insert>

19972

<dialog title="Insert ob_end_clean">ob_end_clean();</dialog>

19973

19974

</function>

19975

19976

19977

Flush (send) the output buffer and turn off output buffering

19978

</description>

19979

19980

<insert>ob_end_flush();</insert>

19981

<dialog title="Insert ob_end_flush">ob_end_flush();</dialog>

19982

19983

</function>

19984

19985

19986

Flush (send) the output buffer

19987

</description>

19988

19989

<insert>ob_flush();</insert>

19990

<dialog title="Insert ob_flush">ob_flush();</dialog>

19991

19992

</function>

19993

19994

19995

Return the contents of the output buffer

19996

</description>

19997

<return type="string">string</return>

19998

<insert>ob_get_contents();</insert>

19999

<dialog title="Insert ob_get_contents">ob_get_contents();</dialog>

20000

20001

</function>

20002

20003

20004

Return the length of the output buffer

20005

</description>

20006

20007

<insert>ob_get_length();</insert>

20008

<dialog title="Insert ob_get_length">ob_get_length();</dialog>

20009

20010

</function>

20011

20012

20013

Return the nesting level of the output buffering mechanism

20014

</description>

20015

20016

<insert>ob_get_level();</insert>

20017

<dialog title="Insert ob_get_level">ob_get_level();</dialog>

20018

20019

</function>

20020

20021

20022

Get status of output buffers

20023

</description>

20024

<param name="

20025

full_status" required="0" vallist="0" default="" type="bool">

20026

full_status</param>

20027

<return type="array">array</return>

20028

<insert>ob_get_status([bool

20029

full_status]);</insert>

20030

<dialog title="Insert ob_get_status">ob_get_status(%0);</dialog>

20031

20032

</function>

20033

20034

20035

ob_start callback function to gzip output buffer

20036

</description>

20037

<param name="buffer" required="1" vallist="0" default="" type="string">buffer</param>

20038

20039

<return type="string">string</return>

20040

<insert>ob_gzhandler(string buffer [,int mode]);</insert>

20041

<dialog title="Insert ob_gzhandler">ob_gzhandler(%0, %1);</dialog>

20042

20043

</function>

20044

20045

20046

Turn implicit flush on/off

20047

</description>

20048

20049

20050

<insert>ob_implicit_flush([int flag]);</insert>

20051

<dialog title="Insert ob_implicit_flush">ob_implicit_flush(%0);</dialog>

20052

20053

</function>

20054

20055

<description>Turn on output buffering</description>

20056

<param name="

20057

output_callback

20058

" required="0" vallist="0" default="" type="string">

20059

output_callback

20060

</param>

20061

20062

<insert>ob_start([string

20063

output_callback

20064

]);</insert>

20065

<dialog title="Insert ob_start">ob_start(%0);</dialog>

20066

20067

</function>

20068

</group>

20069

20070

20071

<description>Enable property and method call overloading for a class</description>

20072

<param name="class_name" required="0" vallist="0" default="" type="string">class_name</param>

20073

20074

<insert>overload([string class_name]);</insert>

20075

<dialog title="Insert overload">overload(%0);</dialog>

20076

20077

</function>

20078

</group>

20079

20080

20081

<description>Closes the connection to ovrimos</description>

20082

<param name="connection" required="1" vallist="0" default="" type="int">connection</param>

20083

20084

<insert>ovrimos_close(int connection);</insert>

20085

<dialog title="Insert ovrimos_close">ovrimos_close(%0);</dialog>

20086

20087

</function>

20088

20089

<description>Commits the transaction</description>

20090

<param name="connection_id" required="1" vallist="0" default="" type="int">connection_id</param>

20091

20092

<insert>ovrimos_commit(int connection_id);</insert>

20093

<dialog title="Insert ovrimos_commit">ovrimos_commit(%0);</dialog>

20094

20095

</function>

20096

20097

<description>Connect to the specified database</description>

20098

20099

20100

20101

<param name="password" required="1" vallist="0" default="" type="string">password</param>

20102

20103

<insert>ovrimos_connect(string host, string db, string user, string password);</insert>

20104

<dialog title="Insert ovrimos_connect">ovrimos_connect(%0, %1, %2, %3);</dialog>

20105

20106

</function>

20107

20108

<description>Returns the name of the cursor</description>

20109

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20110

20111

<insert>ovrimos_cursor(int result_id);</insert>

20112

<dialog title="Insert ovrimos_cursor">ovrimos_cursor(%0);</dialog>

20113

20114

</function>

20115

20116

<description>Executes an SQL statement</description>

20117

<param name="connection_id" required="1" vallist="0" default="" type="int">connection_id</param>

20118

<param name="query" required="1" vallist="0" default="" type="string">query</param>

20119

20120

<insert>ovrimos_exec(int connection_id, string query);</insert>

20121

<dialog title="Insert ovrimos_exec">ovrimos_exec(%0, %1);</dialog>

20122

20123

</function>

20124

20125

<description>Executes a prepared SQL statement</description>

20126

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20127

<param name="parameters_array" required="0" vallist="0" default="" type="array">parameters_array</param>

20128

20129

<insert>ovrimos_execute(int result_id [,array parameters_array]);</insert>

20130

<dialog title="Insert ovrimos_execute">ovrimos_execute(%0, %1);</dialog>

20131

20132

</function>

20133

20134

<description>Fetches a row from the result set</description>

20135

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20136

<param name="result_array" required="1" vallist="0" default="" type="array">result_array</param>

20137

20138

<param name="rownumber" required="0" vallist="0" default="" type="int">rownumber</param>

20139

20140

<insert>ovrimos_fetch_into(int result_id, array result_array [,string how] [,int rownumber]);</insert>

20141

<dialog title="Insert ovrimos_fetch_into">ovrimos_fetch_into(%0, %1, %2, %3);</dialog>

20142

20143

</function>

20144

20145

<description>Fetches a row from the result set</description>

20146

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20147

20148

<param name="row_number" required="0" vallist="0" default="" type="int">row_number</param>

20149

20150

<insert>ovrimos_fetch_row(int result_id [,int how] [,int row_number]);</insert>

20151

<dialog title="Insert ovrimos_fetch_row">ovrimos_fetch_row(%0, %1, %2);</dialog>

20152

20153

</function>

20154

20155

<description>Returns the length of the output column</description>

20156

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20157

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

20158

20159

<insert>ovrimos_field_len(int result_id, int field_number);</insert>

20160

<dialog title="Insert ovrimos_field_len">ovrimos_field_len(%0, %1);</dialog>

20161

20162

</function>

20163

20164

<description>Returns the output column name</description>

20165

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20166

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

20167

20168

<insert>ovrimos_field_name(int result_id, int field_number);</insert>

20169

<dialog title="Insert ovrimos_field_name">ovrimos_field_name(%0, %1);</dialog>

20170

20171

</function>

20172

20173

20174

Returns the (1-based) index of the output column

20175

</description>

20176

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20177

<param name="field_name" required="1" vallist="0" default="" type="string">field_name</param>

20178

20179

<insert>ovrimos_field_num(int result_id, string field_name);</insert>

20180

<dialog title="Insert ovrimos_field_num">ovrimos_field_num(%0, %1);</dialog>

20181

20182

</function>

20183

20184

20185

Returns the (numeric) type of the output column

20186

</description>

20187

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20188

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

20189

20190

<insert>ovrimos_field_type(int result_id, int field_number);</insert>

20191

<dialog title="Insert ovrimos_field_type">ovrimos_field_type(%0, %1);</dialog>

20192

20193

</function>

20194

20195

<description>Frees the specified result_id</description>

20196

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20197

20198

<insert>ovrimos_free_result(int result_id);</insert>

20199

<dialog title="Insert ovrimos_free_result">ovrimos_free_result(%0);</dialog>

20200

20201

</function>

20202

20203

20204

Specifies how many bytes are to be retrieved from long datatypes

20205

</description>

20206

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20207

<param name="length" required="1" vallist="0" default="" type="int">length</param>

20208

20209

<insert>ovrimos_longreadlen(int result_id, int length);</insert>

20210

<dialog title="Insert ovrimos_longreadlen">ovrimos_longreadlen(%0, %1);</dialog>

20211

20212

</function>

20213

20214

<description>Returns the number of columns</description>

20215

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20216

20217

<insert>ovrimos_num_fields(int result_id);</insert>

20218

<dialog title="Insert ovrimos_num_fields">ovrimos_num_fields(%0);</dialog>

20219

20220

</function>

20221

20222

20223

Returns the number of rows affected by update operations

20224

</description>

20225

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20226

20227

<insert>ovrimos_num_rows(int result_id);</insert>

20228

<dialog title="Insert ovrimos_num_rows">ovrimos_num_rows(%0);</dialog>

20229

20230

</function>

20231

20232

<description>Prepares an SQL statement</description>

20233

<param name="connection_id" required="1" vallist="0" default="" type="int">connection_id</param>

20234

<param name="query" required="1" vallist="0" default="" type="string">query</param>

20235

20236

<insert>ovrimos_prepare(int connection_id, string query);</insert>

20237

<dialog title="Insert ovrimos_prepare">ovrimos_prepare(%0, %1);</dialog>

20238

20239

</function>

20240

20241

20242

Prints the whole result set as an HTML table

20243

</description>

20244

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20245

<param name="format" required="0" vallist="0" default="" type="string">format</param>

20246

20247

<insert>ovrimos_result_all(int result_id [,string format]);</insert>

20248

<dialog title="Insert ovrimos_result_all">ovrimos_result_all(%0, %1);</dialog>

20249

20250

</function>

20251

20252

<description>Retrieves the output column</description>

20253

<param name="result_id" required="1" vallist="0" default="" type="int">result_id</param>

20254

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

20255

20256

<insert>ovrimos_result(int result_id, mixed field);</insert>

20257

<dialog title="Insert ovrimos_result">ovrimos_result(%0, %1);</dialog>

20258

20259

</function>

20260

20261

<description>Rolls back the transaction</description>

20262

<param name="connection_id" required="1" vallist="0" default="" type="int">connection_id</param>

20263

20264

<insert>ovrimos_rollback(int connection_id);</insert>

20265

<dialog title="Insert ovrimos_rollback">ovrimos_rollback(%0);</dialog>

20266

20267

</function>

20268

</group>

20269

20270

20271

20272

Executes specified program in current process space

20273

</description>

20274

20275

20276

20277

20278

<insert>pcntl_exec(string path [,array args] [,array envs]);</insert>

20279

<dialog title="Insert pcntl_exec">pcntl_exec(%0, %1, %2);</dialog>

20280

20281

</function>

20282

20283

<description>Forks the currently running process</description>

20284

20285

<insert>pcntl_fork();</insert>

20286

<dialog title="Insert pcntl_fork">pcntl_fork();</dialog>

20287

20288

</function>

20289

20290

<description>Installs a signal handler</description>

20291

<param name="signo" required="1" vallist="0" default="" type="int">signo</param>

20292

<param name="handle" required="1" vallist="0" default="" type="mixed">handle</param>

20293

<param name="restart_syscalls" required="0" vallist="0" default="" type="bool">restart_syscalls</param>

20294

20295

<insert>pcntl_signal(int signo, mixed handle [,bool restart_syscalls]);</insert>

20296

<dialog title="Insert pcntl_signal">pcntl_signal(%0, %1, %2);</dialog>

20297

20298

</function>

20299

20300

<description>Waits on or returns the status of a forked child</description>

20301

20302

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20303

<param name="options" required="1" vallist="0" default="" type="int">options</param>

20304

20305

<insert>pcntl_waitpid(int pid, int status, int options);</insert>

20306

<dialog title="Insert pcntl_waitpid">pcntl_waitpid(%0, %1, %2);</dialog>

20307

20308

</function>

20309

20310

20311

Returns the return code of a terminated child

20312

</description>

20313

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20314

20315

<insert>pcntl_wexitstatus(int status);</insert>

20316

<dialog title="Insert pcntl_wexitstatus">pcntl_wexitstatus(%0);</dialog>

20317

20318

</function>

20319

20320

20321

Returns </description>

20322

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20323

20324

<insert>pcntl_wifexited(int status);</insert>

20325

<dialog title="Insert pcntl_wifexited">pcntl_wifexited(%0);</dialog>

20326

20327

</function>

20328

20329

20330

Returns </description>

20331

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20332

20333

<insert>pcntl_wifsignaled(int status);</insert>

20334

<dialog title="Insert pcntl_wifsignaled">pcntl_wifsignaled(%0);</dialog>

20335

20336

</function>

20337

20338

20339

Returns </description>

20340

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20341

20342

<insert>pcntl_wifstopped(int status);</insert>

20343

<dialog title="Insert pcntl_wifstopped">pcntl_wifstopped(%0);</dialog>

20344

20345

</function>

20346

20347

20348

Returns the signal which caused the child to stop

20349

</description>

20350

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20351

20352

<insert>pcntl_wstopsig(int status);</insert>

20353

<dialog title="Insert pcntl_wstopsig">pcntl_wstopsig(%0);</dialog>

20354

20355

</function>

20356

20357

20358

Returns the signal which caused the child to terminate

20359

</description>

20360

<param name="status" required="1" vallist="0" default="" type="int">status</param>

20361

20362

<insert>pcntl_wtermsig(int status);</insert>

20363

<dialog title="Insert pcntl_wtermsig">pcntl_wtermsig(%0);</dialog>

20364

20365

</function>

20366

</group>

20367

20368

20369

20370

Return array entries that match the pattern

20371

</description>

20372

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

20373

<param name="input" required="1" vallist="0" default="" type="array">input</param>

20374

<return type="array">array</return>

20375

<insert>preg_grep(string pattern, array input);</insert>

20376

20377

20378

</function>

20379

20380

<description>Perform a global regular expression match</description>

20381

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

20382

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

20383

<param name="matches" required="1" vallist="0" default="" type="array">matches</param>

20384

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

20385

20386

<insert>preg_match_all(string pattern, string subject, array matches [,int flags]);</insert>

20387

<dialog title="Insert preg_match_all">preg_match_all(%0, %1, %2, %3);</dialog>

20388

20389

</function>

20390

20391

<description>Perform a regular expression match</description>

20392

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

20393

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

20394

<param name="matches" required="0" vallist="0" default="" type="array">matches</param>

20395

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

20396

20397

<insert>preg_match(string pattern, string subject [,array matches] [,int flags]);</insert>

20398

<dialog title="Insert preg_match">preg_match(%0, %1, %2, %3);</dialog>

20399

20400

</function>

20401

20402

<description>Quote regular expression characters</description>

20403

20404

<param name="delimiter" required="0" vallist="0" default="" type="string">delimiter</param>

20405

<return type="string">string</return>

20406

<insert>preg_quote(string str [,string delimiter]);</insert>

20407

<dialog title="Insert preg_quote">preg_quote(%0, %1);</dialog>

20408

20409

</function>

20410

20411

<description>Perform a regular expression search and replace using a callback</description>

20412

<param name="pattern" required="1" vallist="0" default="" type="mixed">pattern</param>

20413

<param name="callback" required="1" vallist="0" default="" type="callback">callback</param>

20414

<param name="subject" required="1" vallist="0" default="" type="mixed">subject</param>

20415

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

20416

<return type="mixed">mixed</return>

20417

<insert>preg_replace_callback(mixed pattern, callback callback, mixed subject [,int limit]);</insert>

20418

<dialog title="Insert preg_replace_callback">preg_replace_callback(%0, %1, %2, %3);</dialog>

20419

20420

</function>

20421

20422

<description>Perform a regular expression search and replace</description>

20423

<param name="pattern" required="1" vallist="0" default="" type="mixed">pattern</param>

20424

<param name="replacement" required="1" vallist="0" default="" type="mixed">replacement</param>

20425

<param name="subject" required="1" vallist="0" default="" type="mixed">subject</param>

20426

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

20427

<return type="mixed">mixed</return>

20428

<insert>preg_replace(mixed pattern, mixed replacement, mixed subject [,int limit]);</insert>

20429

<dialog title="Insert preg_replace">preg_replace(%0, %1, %2, %3);</dialog>

20430

20431

</function>

20432

20433

<description>Split string by a regular expression</description>

20434

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

20435

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

20436

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

20437

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

20438

<return type="array">array</return>

20439

<insert>preg_split(string pattern, string subject [,int limit] [,int flags]);</insert>

20440

<dialog title="Insert preg_split">preg_split(%0, %1, %2, %3);</dialog>

20441

20442

</function>

20443

</group>

20444

20445

20446

<description>Adds bookmark for current page</description>

20447

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20448

20449

<param name="parent" required="0" vallist="0" default="" type="int">parent</param>

20450

20451

20452

<insert>pdf_add_bookmark(int pdf_object, string text [,int parent] [,int open]);</insert>

20453

<dialog title="Insert pdf_add_bookmark">pdf_add_bookmark(%0, %1, %2, %3);</dialog>

20454

20455

</function>

20456

20457

<description>Add a launch annotation for current page</description>

20458

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20459

20460

20461

20462

20463

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

20464

20465

<insert>pdf_add_launchlink(int pdf_object, float llx, float lly, float urx, float ury, string filename);</insert>

20466

<dialog title="Insert pdf_add_launchlink">pdf_add_launchlink(%0, %1, %2, %3, %4, %5);</dialog>

20467

20468

</function>

20469

20470

<description>Add a link annotation for current page</description>

20471

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20472

20473

20474

20475

20476

20477

20478

20479

<insert>pdf_add_locallink(int pdf_object, float llx, float lly, float urx, float ury, int page, string dest);</insert>

20480

<dialog title="Insert pdf_add_locallink">pdf_add_locallink(%0, %1, %2, %3, %4, %5, %6);</dialog>

20481

20482

</function>

20483

20484

<description>Add a note annotation for current page</description>

20485

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20486

20487

20488

20489

20490

<param name="contents" required="1" vallist="0" default="" type="string">contents</param>

20491

<param name="title" required="1" vallist="0" default="" type="string">title</param>

20492

20493

20494

20495

<insert>pdf_add_note(int pdf_object, float llx, float lly, float urx, float ury, string contents, string title, string icon, int open);</insert>

20496

20497

20498

</function>

20499

20500

<description>Adds file link annotation for current page</description>

20501

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20502

20503

20504

20505

20506

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

20507

20508

20509

20510

<insert>pdf_add_pdflink(int pdf_object, float llx, float lly, float urx, float ury, string filename, int page, string dest);</insert>

20511

<dialog title="Insert pdf_add_pdflink">pdf_add_pdflink(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

20512

20513

</function>

20514

20515

<description>Adds thumbnail for current page</description>

20516

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20517

<param name="image" required="1" vallist="0" default="" type="int">image</param>

20518

20519

<insert>pdf_add_thumbnail(int pdf_object, int image);</insert>

20520

<dialog title="Insert pdf_add_thumbnail">pdf_add_thumbnail(%0, %1);</dialog>

20521

20522

</function>

20523

20524

<description>Adds weblink for current page</description>

20525

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20526

20527

20528

20529

20530

20531

20532

<insert>pdf_add_weblink(int pdf_object, float llx, float lly, float urx, float ury, string url);</insert>

20533

<dialog title="Insert pdf_add_weblink">pdf_add_weblink(%0, %1, %2, %3, %4, %5);</dialog>

20534

20535

</function>

20536

20537

<description>Draws an arc (counterclockwise)</description>

20538

<param name="pdf_object" required="1" vallist="0" default="" type="resource">pdf_object</param>

20539

20540

20541

20542

<param name="alpha" required="1" vallist="0" default="" type="float">alpha</param>

20543

20544

20545

<insert>pdf_arc(resource pdf_object, float x, float y, float r, float alpha, float beta);</insert>

20546

20547

20548

</function>

20549

20550

<description>Draws an arc (clockwise)</description>

20551

<param name="pdf_object" required="1" vallist="0" default="" type="resource">pdf_object</param>

20552

20553

20554

20555

<param name="alpha" required="1" vallist="0" default="" type="float">alpha</param>

20556

20557

20558

<insert>pdf_arcn(resource pdf_object, float x, float y, float r, float alpha, float beta);</insert>

20559

20560

20561

</function>

20562

20563

<description>Adds a file attachement for current page</description>

20564

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20565

20566

20567

20568

20569

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

20570

<param name="description" required="1" vallist="0" default="" type="string">description</param>

20571

<param name="author" required="1" vallist="0" default="" type="string">author</param>

20572

<param name="mimetype" required="1" vallist="0" default="" type="string">mimetype</param>

20573

20574

20575

<insert>pdf_attach_file(int pdf_object, float llx, float lly, float urx, float ury, string filename, string description, string author, string mimetype, string icon);</insert>

20576

<dialog title="Insert pdf_attach_file">pdf_attach_file(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9);</dialog>

20577

20578

</function>

20579

20580

<description>Starts new page</description>

20581

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20582

<param name="width" required="1" vallist="0" default="" type="float">width</param>

20583

<param name="height" required="1" vallist="0" default="" type="float">height</param>

20584

20585

<insert>pdf_begin_page(int pdf_object, float width, float height);</insert>

20586

<dialog title="Insert pdf_begin_page">pdf_begin_page(%0, %1, %2);</dialog>

20587

20588

</function>

20589

20590

<description>Starts new pattern</description>

20591

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20592

<param name="width" required="1" vallist="0" default="" type="float">width</param>

20593

<param name="height" required="1" vallist="0" default="" type="float">height</param>

20594

<param name="xstep" required="1" vallist="0" default="" type="float">xstep</param>

20595

<param name="ystep" required="1" vallist="0" default="" type="float">ystep</param>

20596

<param name="painttype" required="1" vallist="0" default="" type="int">painttype</param>

20597

20598

<insert>pdf_begin_pattern(int pdf_object, float width, float height, float xstep, float ystep, int painttype);</insert>

20599

<dialog title="Insert pdf_begin_pattern">pdf_begin_pattern(%0, %1, %2, %3, %4, %5);</dialog>

20600

20601

</function>

20602

20603

<description>Starts new template</description>

20604

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20605

<param name="width" required="1" vallist="0" default="" type="float">width</param>

20606

<param name="height" required="1" vallist="0" default="" type="float">height</param>

20607

20608

<insert>pdf_begin_template(int pdf_object, float width, float height);</insert>

20609

<dialog title="Insert pdf_begin_template">pdf_begin_template(%0, %1, %2);</dialog>

20610

20611

</function>

20612

20613

<description>Draws a circle</description>

20614

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20615

20616

20617

20618

20619

<insert>pdf_circle(int pdf_object, float x, float y, float r);</insert>

20620

<dialog title="Insert pdf_circle">pdf_circle(%0, %1, %2, %3);</dialog>

20621

20622

</function>

20623

20624

<description>Clips to current path</description>

20625

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20626

20627

<insert>pdf_clip(int pdf_object);</insert>

20628

20629

20630

</function>

20631

20632

<description>Closes an image</description>

20633

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20634

<param name="image" required="1" vallist="0" default="" type="int">image</param>

20635

20636

<insert>pdf_close_image(int pdf_object, int image);</insert>

20637

<dialog title="Insert pdf_close_image">pdf_close_image(%0, %1);</dialog>

20638

20639

</function>

20640

20641

20642

Close the page handle

20643

</description>

20644

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20645

<param name="pagehandle" required="1" vallist="0" default="" type="int">pagehandle</param>

20646

20647

<insert>pdf_close_pdi_page(int pdf_object, int pagehandle);</insert>

20648

<dialog title="Insert pdf_close_pdi_page">pdf_close_pdi_page(%0, %1);</dialog>

20649

20650

</function>

20651

20652

20653

Close the input PDF document

20654

</description>

20655

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20656

<param name="dochandle" required="1" vallist="0" default="" type="int">dochandle</param>

20657

20658

<insert>pdf_close_pdi(int pdf_object, int dochandle);</insert>

20659

<dialog title="Insert pdf_close_pdi">pdf_close_pdi(%0, %1);</dialog>

20660

20661

</function>

20662

20663

<description>Closes a pdf object</description>

20664

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20665

20666

<insert>pdf_close(int pdf_object);</insert>

20667

<dialog title="Insert pdf_close">pdf_close(%0);</dialog>

20668

20669

</function>

20670

20671

<description>Closes, fills and strokes current path</description>

20672

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20673

20674

<insert>pdf_closepath_fill_stroke(int pdf_object);</insert>

20675

<dialog title="Insert pdf_closepath_fill_stroke">pdf_closepath_fill_stroke(%0);</dialog>

20676

20677

</function>

20678

20679

<description>Closes path and draws line along path</description>

20680

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20681

20682

<insert>pdf_closepath_stroke(int pdf_object);</insert>

20683

<dialog title="Insert pdf_closepath_stroke">pdf_closepath_stroke(%0);</dialog>

20684

20685

</function>

20686

20687

<description>Closes path</description>

20688

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20689

20690

<insert>pdf_closepath(int pdf_object);</insert>

20691

<dialog title="Insert pdf_closepath">pdf_closepath(%0);</dialog>

20692

20693

</function>

20694

20695

<description>Concatenate a matrix to the CTM</description>

20696

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20697

20698

20699

20700

20701

20702

20703

20704

<insert>pdf_concat(int pdf_object, float a, float b, float c, float d, float e, float f);</insert>

20705

<dialog title="Insert pdf_concat">pdf_concat(%0, %1, %2, %3, %4, %5, %6);</dialog>

20706

20707

</function>

20708

20709

<description>Outputs text in next line</description>

20710

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20711

20712

20713

<insert>pdf_continue_text(int pdf_object, string text);</insert>

20714

<dialog title="Insert pdf_continue_text">pdf_continue_text(%0, %1);</dialog>

20715

20716

</function>

20717

20718

<description>Draws a curve</description>

20719

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20720

20721

20722

20723

20724

20725

20726

20727

<insert>pdf_curveto(int pdf_object, float x1, float y1, float x2, float y2, float x3, float y3);</insert>

20728

<dialog title="Insert pdf_curveto">pdf_curveto(%0, %1, %2, %3, %4, %5, %6);</dialog>

20729

20730

</function>

20731

20732

<description>Deletes a PDF object</description>

20733

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20734

20735

<insert>pdf_delete(int pdf_object);</insert>

20736

<dialog title="Insert pdf_delete">pdf_delete(%0);</dialog>

20737

20738

</function>

20739

20740

20741

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20742

20743

<insert>pdf_end_page(int pdf_object);</insert>

20744

20745

20746

</function>

20747

20748

<description>Finish pattern</description>

20749

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20750

20751

<insert>pdf_end_pattern(int pdf_object);</insert>

20752

<dialog title="Insert pdf_end_pattern">pdf_end_pattern(%0);</dialog>

20753

20754

</function>

20755

20756

<description>Finish template</description>

20757

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20758

20759

<insert>pdf_end_template(int pdf_object);</insert>

20760

<dialog title="Insert pdf_end_template">pdf_end_template(%0);</dialog>

20761

20762

</function>

20763

20764

<description>Fills and strokes current path</description>

20765

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20766

20767

<insert>pdf_fill_stroke(int pdf_object);</insert>

20768

<dialog title="Insert pdf_fill_stroke">pdf_fill_stroke(%0);</dialog>

20769

20770

</function>

20771

20772

<description>Fills current path</description>

20773

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20774

20775

<insert>pdf_fill(int pdf_object);</insert>

20776

20777

20778

</function>

20779

20780

<description>Prepare font for later use with </description>

20781

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20782

<param name="fontname" required="1" vallist="0" default="" type="string">fontname</param>

20783

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

20784

<param name="embed" required="1" vallist="0" default="" type="int">embed</param>

20785

20786

<insert>pdf_findfont(int pdf_object, string fontname, string encoding, int embed);</insert>

20787

<dialog title="Insert pdf_findfont">pdf_findfont(%0, %1, %2, %3);</dialog>

20788

20789

</function>

20790

20791

<description>Fetch the buffer containig the generated PDF data.</description>

20792

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20793

<return type="string">string</return>

20794

<insert>pdf_get_buffer(int pdf_object);</insert>

20795

<dialog title="Insert pdf_get_buffer">pdf_get_buffer(%0);</dialog>

20796

20797

</function>

20798

20799

<description>Returns height of an image</description>

20800

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20801

<param name="image" required="1" vallist="0" default="" type="int">image</param>

20802

<return type="string">string</return>

20803

<insert>pdf_get_image_height(int pdf_object, int image);</insert>

20804

<dialog title="Insert pdf_get_image_height">pdf_get_image_height(%0, %1);</dialog>

20805

20806

</function>

20807

20808

<description>Returns width of an image</description>

20809

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20810

<param name="image" required="1" vallist="0" default="" type="int">image</param>

20811

<return type="string">string</return>

20812

<insert>pdf_get_image_width(int pdf_object, int image);</insert>

20813

<dialog title="Insert pdf_get_image_width">pdf_get_image_width(%0, %1);</dialog>

20814

20815

</function>

20816

20817

20818

Returns the major version number of the PDFlib

20819

</description>

20820

20821

<insert>pdf_get_majorversion();</insert>

20822

<dialog title="Insert pdf_get_majorversion">pdf_get_majorversion();</dialog>

20823

20824

</function>

20825

20826

20827

Returns the minor version number of the PDFlib

20828

</description>

20829

20830

<insert>pdf_get_minorversion();</insert>

20831

<dialog title="Insert pdf_get_minorversion">pdf_get_minorversion();</dialog>

20832

20833

</function>

20834

20835

<description>Gets certain parameters</description>

20836

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20837

20838

<param name="modifier" required="0" vallist="0" default="" type="float">modifier</param>

20839

<return type="string">string</return>

20840

<insert>pdf_get_parameter(int pdf_object, string key [,float modifier]);</insert>

20841

<dialog title="Insert pdf_get_parameter">pdf_get_parameter(%0, %1, %2);</dialog>

20842

20843

</function>

20844

20845

<description>Get some PDI string parameters</description>

20846

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20847

20848

20849

20850

<param name="index" required="1" vallist="0" default="" type="int">index</param>

20851

<return type="string">string</return>

20852

<insert>pdf_get_pdi_parameter(int pdf_object, string key, int doc, int page, int index);</insert>

20853

<dialog title="Insert pdf_get_pdi_parameter">pdf_get_pdi_parameter(%0, %1, %2, %3, %4);</dialog>

20854

20855

</function>

20856

20857

<description>Gets some PDI numerical parameters</description>

20858

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20859

20860

20861

20862

<param name="index" required="1" vallist="0" default="" type="int">index</param>

20863

<return type="string">string</return>

20864

<insert>pdf_get_pdi_value(int pdf_object, string key, int doc, int page, int index);</insert>

20865

<dialog title="Insert pdf_get_pdi_value">pdf_get_pdi_value(%0, %1, %2, %3, %4);</dialog>

20866

20867

</function>

20868

20869

<description>Gets certain numerical value</description>

20870

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20871

20872

<param name="modifier" required="0" vallist="0" default="" type="float">modifier</param>

20873

<return type="float">float</return>

20874

<insert>pdf_get_value(int pdf_object, string key [,float modifier]);</insert>

20875

<dialog title="Insert pdf_get_value">pdf_get_value(%0, %1, %2);</dialog>

20876

20877

</function>

20878

20879

<description>Resets graphic state</description>

20880

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20881

20882

<insert>pdf_initgraphics(int pdf_object);</insert>

20883

<dialog title="Insert pdf_initgraphics">pdf_initgraphics(%0);</dialog>

20884

20885

</function>

20886

20887

<description>Draws a line</description>

20888

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20889

20890

20891

20892

<insert>pdf_lineto(int pdf_object, float x, float y);</insert>

20893

<dialog title="Insert pdf_lineto">pdf_lineto(%0, %1, %2);</dialog>

20894

20895

</function>

20896

20897

<description>Makes a spotcolor</description>

20898

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20899

<param name="spotname" required="1" vallist="0" default="" type="string">spotname</param>

20900

20901

<insert>pdf_makespotcolor(int pdf_object, string spotname);</insert>

20902

<dialog title="Insert pdf_makespotcolor">pdf_makespotcolor(%0, %1);</dialog>

20903

20904

</function>

20905

20906

<description>Sets current point</description>

20907

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20908

20909

20910

20911

<insert>pdf_moveto(int pdf_object, float x, float y);</insert>

20912

<dialog title="Insert pdf_moveto">pdf_moveto(%0, %1, %2);</dialog>

20913

20914

</function>

20915

20916

<description>Creates a new pdf object</description>

20917

20918

20919

20920

20921

</function>

20922

20923

<description>Opens a new image file with raw CCITT data</description>

20924

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20925

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

20926

<param name="width" required="1" vallist="0" default="" type="int">width</param>

20927

<param name="height" required="1" vallist="0" default="" type="int">height</param>

20928

<param name="BitReverse" required="1" vallist="0" default="" type="int">BitReverse</param>

20929

20930

<param name="Blackls1" required="1" vallist="0" default="" type="int">Blackls1</param>

20931

20932

<insert>pdf_open_CCITT(int pdf_object, string filename, int width, int height, int BitReverse, int k, int Blackls1);</insert>

20933

<dialog title="Insert pdf_open_CCITT">pdf_open_CCITT(%0, %1, %2, %3, %4, %5, %6);</dialog>

20934

20935

</function>

20936

20937

<description>Opens a new pdf object</description>

20938

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20939

<param name="filename" required="0" vallist="0" default="" type="string">filename</param>

20940

20941

<insert>pdf_open_file(int pdf_object [,string filename]);</insert>

20942

20943

20944

</function>

20945

20946

<description>Reads an image from a file</description>

20947

<param name="PDF-document" required="1" vallist="0" default="" type="int">PDF-document</param>

20948

<param name="imagetype" required="1" vallist="0" default="" type="string">imagetype</param>

20949

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

20950

<param name="stringparam" required="0" vallist="0" default="" type="string">stringparam</param>

20951

<param name="intparam" required="0" vallist="0" default="" type="string">intparam</param>

20952

20953

<insert>pdf_open_image_file(int PDF-document, string imagetype, string filename [,string stringparam] [,string intparam]);</insert>

20954

<dialog title="Insert pdf_open_image_file">pdf_open_image_file(%0, %1, %2, %3, %4);</dialog>

20955

20956

</function>

20957

20958

<description>Versatile function for images</description>

20959

<param name="PDF-document" required="1" vallist="0" default="" type="int">PDF-document</param>

20960

<param name="imagetype" required="1" vallist="0" default="" type="string">imagetype</param>

20961

<param name="source" required="1" vallist="0" default="" type="string">source</param>

20962

20963

<param name="length" required="1" vallist="0" default="" type="long">length</param>

20964

<param name="width" required="1" vallist="0" default="" type="int">width</param>

20965

<param name="height" required="1" vallist="0" default="" type="int">height</param>

20966

<param name="components" required="1" vallist="0" default="" type="int">components</param>

20967

20968

<param name="params" required="1" vallist="0" default="" type="string">params</param>

20969

20970

<insert>pdf_open_image(int PDF-document, string imagetype, string source, string data, long length, int width, int height, int components, int bpc, string params);</insert>

20971

<dialog title="Insert pdf_open_image">pdf_open_image(%0, %1, %2, %3, %4, %5, %6, %7, %8, %9);</dialog>

20972

20973

</function>

20974

20975

<description>Opens an image created with PHP's image functions</description>

20976

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20977

<param name="image" required="1" vallist="0" default="" type="int">image</param>

20978

20979

<insert>pdf_open_memory_image(int pdf_object, int image);</insert>

20980

<dialog title="Insert pdf_open_memory_image">pdf_open_memory_image(%0, %1);</dialog>

20981

20982

</function>

20983

20984

20985

Prepare a page

20986

</description>

20987

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

20988

<param name="dochandle" required="1" vallist="0" default="" type="int">dochandle</param>

20989

<param name="pagenumber" required="1" vallist="0" default="" type="int">pagenumber</param>

20990

<param name="pagelabel" required="1" vallist="0" default="" type="string">pagelabel</param>

20991

20992

<insert>pdf_open_pdi_page(int pdf_object, int dochandle, int pagenumber, string pagelabel);</insert>

20993

20994

20995

</function>

20996

20997

20998

Opens a PDF file

20999

</description>

21000

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21001

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

21002

<param name="stringparam" required="1" vallist="0" default="" type="string">stringparam</param>

21003

<param name="intparam" required="1" vallist="0" default="" type="int">intparam</param>

21004

21005

<insert>pdf_open_pdi(int pdf_object, string filename, string stringparam, int intparam);</insert>

21006

21007

21008

</function>

21009

21010

<description>Deprecated: Opens a TIFF image</description>

21011

<param name="PDF-document" required="1" vallist="0" default="" type="int">PDF-document</param>

21012

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

21013

21014

<insert>pdf_open_tiff(int PDF-document, string filename);</insert>

21015

21016

21017

</function>

21018

21019

<description>Places an image on the page</description>

21020

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21021

<param name="image" required="1" vallist="0" default="" type="int">image</param>

21022

21023

21024

<param name="scale" required="1" vallist="0" default="" type="float">scale</param>

21025

21026

<insert>pdf_place_image(int pdf_object, int image, float x, float y, float scale);</insert>

21027

<dialog title="Insert pdf_place_image">pdf_place_image(%0, %1, %2, %3, %4);</dialog>

21028

21029

</function>

21030

21031

<description>Places an image on the page</description>

21032

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21033

21034

21035

21036

21037

21038

21039

<insert>pdf_place_pdi_page(int pdf_object, int page, float x, float y, float sx, float sy);</insert>

21040

<dialog title="Insert pdf_place_pdi_page">pdf_place_pdi_page(%0, %1, %2, %3, %4, %5);</dialog>

21041

21042

</function>

21043

21044

<description>Draws a rectangle</description>

21045

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21046

21047

21048

<param name="width" required="1" vallist="0" default="" type="float">width</param>

21049

<param name="height" required="1" vallist="0" default="" type="float">height</param>

21050

21051

<insert>pdf_rect(int pdf_object, float x, float y, float width, float height);</insert>

21052

21053

21054

</function>

21055

21056

<description>Restores formerly saved environment</description>

21057

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21058

21059

<insert>pdf_restore(int pdf_object);</insert>

21060

<dialog title="Insert pdf_restore">pdf_restore(%0);</dialog>

21061

21062

</function>

21063

21064

<description>Sets rotation</description>

21065

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21066

21067

21068

<insert>pdf_rotate(int pdf_object, float phi);</insert>

21069

<dialog title="Insert pdf_rotate">pdf_rotate(%0, %1);</dialog>

21070

21071

</function>

21072

21073

<description>Saves the current environment</description>

21074

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21075

21076

<insert>pdf_save(int pdf_object);</insert>

21077

21078

21079

</function>

21080

21081

<description>Sets scaling</description>

21082

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21083

<param name="x-scale" required="1" vallist="0" default="" type="float">x-scale</param>

21084

<param name="y-scale" required="1" vallist="0" default="" type="float">y-scale</param>

21085

21086

<insert>pdf_scale(int pdf_object, float x-scale, float y-scale);</insert>

21087

<dialog title="Insert pdf_scale">pdf_scale(%0, %1, %2);</dialog>

21088

21089

</function>

21090

21091

<description>Sets color of border around links and annotations</description>

21092

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21093

21094

<param name="green" required="1" vallist="0" default="" type="float">green</param>

21095

21096

21097

<insert>pdf_set_border_color(int pdf_object, float red, float green, float blue);</insert>

21098

<dialog title="Insert pdf_set_border_color">pdf_set_border_color(%0, %1, %2, %3);</dialog>

21099

21100

</function>

21101

21102

<description>Sets dash style of border around links and annotations</description>

21103

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21104

<param name="black" required="1" vallist="0" default="" type="float">black</param>

21105

<param name="white" required="1" vallist="0" default="" type="float">white</param>

21106

21107

<insert>pdf_set_border_dash(int pdf_object, float black, float white);</insert>

21108

<dialog title="Insert pdf_set_border_dash">pdf_set_border_dash(%0, %1, %2);</dialog>

21109

21110

</function>

21111

21112

<description>Sets style of border around links and annotations</description>

21113

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21114

<param name="style" required="1" vallist="0" default="" type="string">style</param>

21115

<param name="width" required="1" vallist="0" default="" type="float">width</param>

21116

21117

<insert>pdf_set_border_style(int pdf_object, string style, float width);</insert>

21118

<dialog title="Insert pdf_set_border_style">pdf_set_border_style(%0, %1, %2);</dialog>

21119

21120

</function>

21121

21122

<description>Sets horizontal scaling of text</description>

21123

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21124

<param name="scale" required="1" vallist="0" default="" type="float">scale</param>

21125

21126

<insert>pdf_set_horiz_scaling(int pdf_object, float scale);</insert>

21127

<dialog title="Insert pdf_set_horiz_scaling">pdf_set_horiz_scaling(%0, %1);</dialog>

21128

21129

</function>

21130

21131

21132

Fills the author field of the document

21133

</description>

21134

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

21135

<param name="author" required="1" vallist="0" default="" type="string">author</param>

21136

21137

<insert>pdf_set_info_author(int pdfdoc, string author);</insert>

21138

<dialog title="Insert pdf_set_info_author">pdf_set_info_author(%0, %1);</dialog>

21139

21140

</function>

21141

21142

21143

Fills the creator field of the document

21144

</description>

21145

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

21146

<param name="creator" required="1" vallist="0" default="" type="string">creator</param>

21147

21148

<insert>pdf_set_info_creator(int pdfdoc, string creator);</insert>

21149

<dialog title="Insert pdf_set_info_creator">pdf_set_info_creator(%0, %1);</dialog>

21150

21151

</function>

21152

21153

21154

Fills the keywords field of the document

21155

</description>

21156

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

21157

<param name="keywords" required="1" vallist="0" default="" type="string">keywords</param>

21158

21159

<insert>pdf_set_info_keywords(int pdfdoc, string keywords);</insert>

21160

<dialog title="Insert pdf_set_info_keywords">pdf_set_info_keywords(%0, %1);</dialog>

21161

21162

</function>

21163

21164

21165

Fills the subject field of the document

21166

</description>

21167

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

21168

<param name="subject" required="1" vallist="0" default="" type="string">subject</param>

21169

21170

<insert>pdf_set_info_subject(int pdfdoc, string subject);</insert>

21171

<dialog title="Insert pdf_set_info_subject">pdf_set_info_subject(%0, %1);</dialog>

21172

21173

</function>

21174

21175

21176

Fills the title field of the document

21177

</description>

21178

<param name="pdfdoc" required="1" vallist="0" default="" type="int">pdfdoc</param>

21179

<param name="title" required="1" vallist="0" default="" type="string">title</param>

21180

21181

<insert>pdf_set_info_title(int pdfdoc, string title);</insert>

21182

<dialog title="Insert pdf_set_info_title">pdf_set_info_title(%0, %1);</dialog>

21183

21184

</function>

21185

21186

<description>Fills a field of the document information</description>

21187

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21188

21189

<param name="value" required="1" vallist="0" default="" type="string">value</param>

21190

21191

<insert>pdf_set_info(int pdf_object, string key, string value);</insert>

21192

21193

21194

</function>

21195

21196

<description>Sets certain parameters</description>

21197

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21198

21199

<param name="value" required="1" vallist="0" default="" type="string">value</param>

21200

21201

<insert>pdf_set_parameter(int pdf_object, string key, string value);</insert>

21202

<dialog title="Insert pdf_set_parameter">pdf_set_parameter(%0, %1, %2);</dialog>

21203

21204

</function>

21205

21206

<description>Sets text position</description>

21207

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21208

21209

21210

21211

<insert>pdf_set_text_pos(int pdf_object, float x, float y);</insert>

21212

21213

21214

</function>

21215

21216

<description>Sets certain numerical value</description>

21217

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21218

21219

<param name="value" required="1" vallist="0" default="" type="float">value</param>

21220

21221

<insert>pdf_set_value(int pdf_object, string key, float value);</insert>

21222

<dialog title="Insert pdf_set_value">pdf_set_value(%0, %1, %2);</dialog>

21223

21224

</function>

21225

21226

<description>Sets fill and stroke color</description>

21227

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21228

21229

<param name="colorspace" required="1" vallist="0" default="" type="string">colorspace</param>

21230

21231

21232

21233

21234

21235

<insert>pdf_setcolor(int pdf_object, string type, string colorspace, float c1 [,float c2] [,float c3] [,float c4]);</insert>

21236

<dialog title="Insert pdf_setcolor">pdf_setcolor(%0, %1, %2, %3, %4, %5, %6);</dialog>

21237

21238

</function>

21239

21240

<description>Sets dash pattern</description>

21241

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21242

21243

21244

21245

<insert>pdf_setdash(int pdf_object, float b, float w);</insert>

21246

<dialog title="Insert pdf_setdash">pdf_setdash(%0, %1, %2);</dialog>

21247

21248

</function>

21249

21250

<description>Sets flatness</description>

21251

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21252

<param name="flatness" required="1" vallist="0" default="" type="float">flatness</param>

21253

21254

<insert>pdf_setflat(int pdf_object, float flatness);</insert>

21255

<dialog title="Insert pdf_setflat">pdf_setflat(%0, %1);</dialog>

21256

21257

</function>

21258

21259

<description>Set the current font</description>

21260

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21261

21262

21263

21264

<insert>pdf_setfont(int pdf_object, int font, float size);</insert>

21265

<dialog title="Insert pdf_setfont">pdf_setfont(%0, %1, %2);</dialog>

21266

21267

</function>

21268

21269

<description>Sets filling color to gray value</description>

21270

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21271

21272

21273

<insert>pdf_setgray_fill(int pdf_object, float gray);</insert>

21274

<dialog title="Insert pdf_setgray_fill">pdf_setgray_fill(%0, %1);</dialog>

21275

21276

</function>

21277

21278

<description>Sets drawing color to gray value</description>

21279

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21280

21281

21282

<insert>pdf_setgray_stroke(int pdf_object, float gray);</insert>

21283

<dialog title="Insert pdf_setgray_stroke">pdf_setgray_stroke(%0, %1);</dialog>

21284

21285

</function>

21286

21287

<description>Sets drawing and filling color to gray value</description>

21288

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21289

21290

21291

<insert>pdf_setgray(int pdf_object, float gray);</insert>

21292

<dialog title="Insert pdf_setgray">pdf_setgray(%0, %1);</dialog>

21293

21294

</function>

21295

21296

<description>Sets linecap parameter</description>

21297

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21298

<param name="linecap" required="1" vallist="0" default="" type="int">linecap</param>

21299

21300

<insert>pdf_setlinecap(int pdf_object, int linecap);</insert>

21301

<dialog title="Insert pdf_setlinecap">pdf_setlinecap(%0, %1);</dialog>

21302

21303

</function>

21304

21305

<description>Sets linejoin parameter</description>

21306

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21307

<param name="value" required="1" vallist="0" default="" type="int">value</param>

21308

21309

<insert>pdf_setlinejoin(int pdf_object, int value);</insert>

21310

<dialog title="Insert pdf_setlinejoin">pdf_setlinejoin(%0, %1);</dialog>

21311

21312

</function>

21313

21314

<description>Sets line width</description>

21315

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21316

<param name="width" required="1" vallist="0" default="" type="float">width</param>

21317

21318

<insert>pdf_setlinewidth(int pdf_object, float width);</insert>

21319

<dialog title="Insert pdf_setlinewidth">pdf_setlinewidth(%0, %1);</dialog>

21320

21321

</function>

21322

21323

<description>Sets current transformation matrix</description>

21324

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21325

21326

21327

21328

21329

21330

21331

21332

<insert>pdf_setmatrix(int pdf_object, float a, float b, float c, float d, float e, float f);</insert>

21333

<dialog title="Insert pdf_setmatrix">pdf_setmatrix(%0, %1, %2, %3, %4, %5, %6);</dialog>

21334

21335

</function>

21336

21337

<description>Sets miter limit</description>

21338

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21339

<param name="miter" required="1" vallist="0" default="" type="float">miter</param>

21340

21341

<insert>pdf_setmiterlimit(int pdf_object, float miter);</insert>

21342

<dialog title="Insert pdf_setmiterlimit">pdf_setmiterlimit(%0, %1);</dialog>

21343

21344

</function>

21345

21346

<description>Sets complicated dash pattern</description>

21347

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21348

<param name="dasharray" required="1" vallist="0" default="" type="float *">dasharray</param>

21349

21350

<insert>pdf_setpolydash(int pdf_object, float * dasharray);</insert>

21351

<dialog title="Insert pdf_setpolydash">pdf_setpolydash(%0, %1);</dialog>

21352

21353

</function>

21354

21355

<description>Sets filling color to rgb color value</description>

21356

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21357

<param name="red value" required="1" vallist="0" default="" type="float">red value</param>

21358

<param name="green value" required="1" vallist="0" default="" type="float">green value</param>

21359

<param name="blue value" required="1" vallist="0" default="" type="float">blue value</param>

21360

21361

<insert>pdf_setrgbcolor_fill(int pdf_object, float red value, float green value, float blue value);</insert>

21362

<dialog title="Insert pdf_setrgbcolor_fill">pdf_setrgbcolor_fill(%0, %1, %2, %3);</dialog>

21363

21364

</function>

21365

21366

<description>Sets drawing color to rgb color value</description>

21367

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21368

<param name="red value" required="1" vallist="0" default="" type="float">red value</param>

21369

<param name="green value" required="1" vallist="0" default="" type="float">green value</param>

21370

<param name="blue value" required="1" vallist="0" default="" type="float">blue value</param>

21371

21372

<insert>pdf_setrgbcolor_stroke(int pdf_object, float red value, float green value, float blue value);</insert>

21373

<dialog title="Insert pdf_setrgbcolor_stroke">pdf_setrgbcolor_stroke(%0, %1, %2, %3);</dialog>

21374

21375

</function>

21376

21377

<description>Sets drawing and filling color to rgb color value</description>

21378

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21379

<param name="red value" required="1" vallist="0" default="" type="float">red value</param>

21380

<param name="green value" required="1" vallist="0" default="" type="float">green value</param>

21381

<param name="blue value" required="1" vallist="0" default="" type="float">blue value</param>

21382

21383

<insert>pdf_setrgbcolor(int pdf_object, float red value, float green value, float blue value);</insert>

21384

<dialog title="Insert pdf_setrgbcolor">pdf_setrgbcolor(%0, %1, %2, %3);</dialog>

21385

21386

</function>

21387

21388

<description>Output text in a box</description>

21389

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21390

21391

21392

21393

<param name="width" required="1" vallist="0" default="" type="float">width</param>

21394

<param name="height" required="1" vallist="0" default="" type="float">height</param>

21395

<param name="hmode" required="1" vallist="0" default="" type="string">hmode</param>

21396

<param name="feature" required="0" vallist="0" default="" type="string">feature</param>

21397

21398

<insert>pdf_show_boxed(int pdf_object, string text, float left, float top, float width, float height, string hmode [,string feature]);</insert>

21399

<dialog title="Insert pdf_show_boxed">pdf_show_boxed(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

21400

21401

</function>

21402

21403

<description>Output text at given position</description>

21404

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21405

21406

21407

21408

21409

<insert>pdf_show_xy(int pdf_object, string text, float x, float y);</insert>

21410

21411

21412

</function>

21413

21414

<description>Output text at current position</description>

21415

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21416

21417

21418

<insert>pdf_show(int pdf_object, string text);</insert>

21419

21420

21421

</function>

21422

21423

<description>Skews the coordinate system</description>

21424

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21425

<param name="alpha" required="1" vallist="0" default="" type="float">alpha</param>

21426

21427

21428

<insert>pdf_skew(int pdf_object, float alpha, float beta);</insert>

21429

21430

21431

</function>

21432

21433

<description>Returns width of text using current font</description>

21434

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21435

21436

21437

21438

<return type="float">float</return>

21439

<insert>pdf_stringwidth(int pdf_object, string text [,int font] [,float size]);</insert>

21440

<dialog title="Insert pdf_stringwidth">pdf_stringwidth(%0, %1, %2, %3);</dialog>

21441

21442

</function>

21443

21444

<description>Draws line along path</description>

21445

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21446

21447

<insert>pdf_stroke(int pdf_object);</insert>

21448

<dialog title="Insert pdf_stroke">pdf_stroke(%0);</dialog>

21449

21450

</function>

21451

21452

<description>Sets origin of coordinate system</description>

21453

<param name="pdf_object" required="1" vallist="0" default="" type="int">pdf_object</param>

21454

21455

21456

21457

<insert>pdf_translate(int pdf_object, float tx, float ty);</insert>

21458

<dialog title="Insert pdf_translate">pdf_translate(%0, %1, %2);</dialog>

21459

21460

</function>

21461

</group>

21462

21463

21464

<description>Shuts down the Payflow Pro library</description>

21465

21466

<insert>pfpro_cleanup();</insert>

21467

<dialog title="Insert pfpro_cleanup">pfpro_cleanup();</dialog>

21468

21469

</function>

21470

21471

<description>Initialises the Payflow Pro library</description>

21472

21473

<insert>pfpro_init();</insert>

21474

<dialog title="Insert pfpro_init">pfpro_init();</dialog>

21475

21476

</function>

21477

21478

<description>Process a raw transaction with Payflow Pro</description>

21479

<param name="parameters" required="1" vallist="0" default="" type="string">parameters</param>

21480

<param name="address" required="0" vallist="0" default="" type="string">address</param>

21481

21482

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

21483

<param name="proxy address" required="0" vallist="0" default="" type="string">proxy address</param>

21484

<param name="proxy port" required="0" vallist="0" default="" type="int">proxy port</param>

21485

<param name="proxy logon" required="0" vallist="0" default="" type="string">proxy logon</param>

21486

<param name="proxy password" required="0" vallist="0" default="" type="string">proxy password</param>

21487

<return type="string">string</return>

21488

<insert>pfpro_process_raw(string parameters [,string address] [,int port] [,int timeout] [,string proxy address] [,int proxy port] [,string proxy logon] [,string proxy password]);</insert>

21489

<dialog title="Insert pfpro_process_raw">pfpro_process_raw(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

21490

21491

</function>

21492

21493

<description>Process a transaction with Payflow Pro</description>

21494

<param name="parameters" required="1" vallist="0" default="" type="array">parameters</param>

21495

<param name="address" required="0" vallist="0" default="" type="string">address</param>

21496

21497

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

21498

<param name="proxy address" required="0" vallist="0" default="" type="string">proxy address</param>

21499

<param name="proxy port" required="0" vallist="0" default="" type="int">proxy port</param>

21500

<param name="proxy logon" required="0" vallist="0" default="" type="string">proxy logon</param>

21501

<param name="proxy password" required="0" vallist="0" default="" type="string">proxy password</param>

21502

<return type="array">array</return>

21503

<insert>pfpro_process(array parameters [,string address] [,int port] [,int timeout] [,string proxy address] [,int proxy port] [,string proxy logon] [,string proxy password]);</insert>

21504

<dialog title="Insert pfpro_process">pfpro_process(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

21505

21506

</function>

21507

21508

<description>Returns the version of the Payflow Pro software</description>

21509

<return type="string">string</return>

21510

<insert>pfpro_version();</insert>

21511

<dialog title="Insert pfpro_version">pfpro_version();</dialog>

21512

21513

</function>

21514

</group>

21515

21516

21517

<description>Returns number of affected records(tuples)</description>

21518

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21519

21520

<insert>pg_affected_rows(resource result);</insert>

21521

<dialog title="Insert pg_affected_rows">pg_affected_rows(%0);</dialog>

21522

21523

</function>

21524

21525

21526

Cancel async query

21527

</description>

21528

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21529

21530

<insert>pg_cancel_query(resource connection);</insert>

21531

<dialog title="Insert pg_cancel_query">pg_cancel_query(%0);</dialog>

21532

21533

</function>

21534

21535

21536

Get the client encoding

21537

</description>

21538

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21539

<return type="string">string</return>

21540

<insert>pg_client_encoding([resource connection]);</insert>

21541

<dialog title="Insert pg_client_encoding">pg_client_encoding(%0);</dialog>

21542

21543

</function>

21544

21545

<description>Close a PostgreSQL connection</description>

21546

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21547

21548

<insert>pg_close(resource connection);</insert>

21549

<dialog title="Insert pg_close">pg_close(%0);</dialog>

21550

21551

</function>

21552

21553

<description>Open a PostgreSQL connection</description>

21554

<param name="connection_string" required="1" vallist="0" default="" type="string">connection_string</param>

21555

<return type="resource">resource</return>

21556

<insert>pg_connect(string connection_string);</insert>

21557

<dialog title="Insert pg_connect">pg_connect(%0);</dialog>

21558

21559

</function>

21560

21561

21562

Get connection is busy or not

21563

</description>

21564

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21565

21566

<insert>pg_connection_busy(resource connection);</insert>

21567

<dialog title="Insert pg_connection_busy">pg_connection_busy(%0);</dialog>

21568

21569

</function>

21570

21571

21572

Reset connection (reconnect)

21573

</description>

21574

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21575

21576

<insert>pg_connection_reset(resource connection);</insert>

21577

<dialog title="Insert pg_connection_reset">pg_connection_reset(%0);</dialog>

21578

21579

</function>

21580

21581

21582

Get connection status

21583

</description>

21584

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21585

21586

<insert>pg_connection_status(resource connection);</insert>

21587

<dialog title="Insert pg_connection_status">pg_connection_status(%0);</dialog>

21588

21589

</function>

21590

21591

21592

Convert associative array value into suitable for SQL statement.

21593

</description>

21594

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21595

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21596

<param name="assoc_array" required="1" vallist="0" default="" type="array">assoc_array</param>

21597

<param name="options" required="0" vallist="0" default="" type="int">options</param>

21598

<return type="array">array</return>

21599

<insert>pg_convert(resource connection, string table_name, array assoc_array [,int options]);</insert>

21600

<dialog title="Insert pg_convert">pg_convert(%0, %1, %2, %3);</dialog>

21601

21602

</function>

21603

21604

21605

Insert records into a table from an array

21606

</description>

21607

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21608

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21609

21610

<param name="delimiter" required="0" vallist="0" default="" type="string">delimiter</param>

21611

21612

21613

<insert>pg_copy_from(resource connection, string table_name, array rows [,string delimiter] [,string null_as]);</insert>

21614

21615

21616

</function>

21617

21618

21619

Copy a table to an array

21620

</description>

21621

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21622

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21623

<param name="delimiter" required="0" vallist="0" default="" type="string">delimiter</param>

21624

21625

<return type="array">array</return>

21626

<insert>pg_copy_to(resource connection, string table_name [,string delimiter] [,string null_as]);</insert>

21627

21628

21629

</function>

21630

21631

<description>Get the database name</description>

21632

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21633

<return type="string">string</return>

21634

<insert>pg_dbname(resource connection);</insert>

21635

<dialog title="Insert pg_dbname">pg_dbname(%0);</dialog>

21636

21637

</function>

21638

21639

21640

Delete records.

21641

</description>

21642

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21643

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21644

<param name="assoc_array" required="1" vallist="0" default="" type="array">assoc_array</param>

21645

<param name="options" required="0" vallist="0" default="" type="int">options</param>

21646

<return type="mixed">mixed</return>

21647

<insert>pg_delete(resource connection, string table_name, array assoc_array [,int options]);</insert>

21648

<dialog title="Insert pg_delete">pg_delete(%0, %1, %2, %3);</dialog>

21649

21650

</function>

21651

21652

<description>Sync with PostgreSQL backend</description>

21653

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21654

21655

<insert>pg_end_copy([resource connection]);</insert>

21656

21657

21658

</function>

21659

21660

21661

Escape binary for bytea type

21662

</description>

21663

21664

<return type="string">string</return>

21665

<insert>pg_escape_bytea(string data);</insert>

21666

<dialog title="Insert pg_escape_bytea">pg_escape_bytea(%0);</dialog>

21667

21668

</function>

21669

21670

21671

Escape string for text/char type

21672

</description>

21673

21674

<return type="string">string</return>

21675

<insert>pg_escape_string(string data);</insert>

21676

<dialog title="Insert pg_escape_string">pg_escape_string(%0);</dialog>

21677

21678

</function>

21679

21680

<description>Fetch a row as an array</description>

21681

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21682

21683

<return type="array">array</return>

21684

<insert>pg_fetch_all(resource result [,int row]);</insert>

21685

<dialog title="Insert pg_fetch_all">pg_fetch_all(%0, %1);</dialog>

21686

21687

</function>

21688

21689

<description>Fetch a row as an array</description>

21690

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21691

21692

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

21693

<return type="array">array</return>

21694

<insert>pg_fetch_array(resource result [,int row] [,int result_type]);</insert>

21695

<dialog title="Insert pg_fetch_array">pg_fetch_array(%0, %1, %2);</dialog>

21696

21697

</function>

21698

21699

<description>Fetch a row as an array</description>

21700

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21701

21702

<return type="array">array</return>

21703

<insert>pg_fetch_assoc(resource result [,int row]);</insert>

21704

<dialog title="Insert pg_fetch_assoc">pg_fetch_assoc(%0, %1);</dialog>

21705

21706

</function>

21707

21708

<description>Fetch a row as an object</description>

21709

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21710

21711

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

21712

<return type="object">object</return>

21713

<insert>pg_fetch_object(resource result [,int row] [,int result_type]);</insert>

21714

<dialog title="Insert pg_fetch_object">pg_fetch_object(%0, %1, %2);</dialog>

21715

21716

</function>

21717

21718

<description>Returns values from a result resource</description>

21719

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21720

21721

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

21722

<return type="mixed">mixed</return>

21723

<insert>pg_fetch_result(resource result, int row, mixed field);</insert>

21724

<dialog title="Insert pg_fetch_result">pg_fetch_result(%0, %1, %2);</dialog>

21725

21726

</function>

21727

21728

<description>Get a row as an enumerated array</description>

21729

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21730

21731

<return type="array">array</return>

21732

<insert>pg_fetch_row(resource result, int row);</insert>

21733

<dialog title="Insert pg_fetch_row">pg_fetch_row(%0, %1);</dialog>

21734

21735

</function>

21736

21737

<description>Test if a field is </description>

21738

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21739

21740

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

21741

21742

<insert>pg_field_is_null(resource result, int row, mixed field);</insert>

21743

<dialog title="Insert pg_field_is_null">pg_field_is_null(%0, %1, %2);</dialog>

21744

21745

</function>

21746

21747

<description>Returns the name of a field</description>

21748

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21749

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

21750

<return type="string">string</return>

21751

<insert>pg_field_name(resource result, int field_number);</insert>

21752

<dialog title="Insert pg_field_name">pg_field_name(%0, %1);</dialog>

21753

21754

</function>

21755

21756

<description>Returns the field number of the named field</description>

21757

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21758

<param name="field_name" required="1" vallist="0" default="" type="string">field_name</param>

21759

21760

<insert>pg_field_num(resource result, string field_name);</insert>

21761

<dialog title="Insert pg_field_num">pg_field_num(%0, %1);</dialog>

21762

21763

</function>

21764

21765

<description>Returns the printed length</description>

21766

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21767

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

21768

<param name="field_name" required="1" vallist="0" default="" type="string">field_name</param>

21769

21770

<insert>pg_field_prtlen(resource result, int row_number, string field_name);</insert>

21771

<dialog title="Insert pg_field_prtlen">pg_field_prtlen(%0, %1, %2);</dialog>

21772

21773

</function>

21774

21775

21776

Returns the internal storage size of the named field

21777

</description>

21778

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21779

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

21780

21781

<insert>pg_field_size(resource result, int field_number);</insert>

21782

<dialog title="Insert pg_field_size">pg_field_size(%0, %1);</dialog>

21783

21784

</function>

21785

21786

21787

Returns the type name for the corresponding field number

21788

</description>

21789

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21790

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

21791

<return type="string">string</return>

21792

<insert>pg_field_type(resource result, int field_number);</insert>

21793

<dialog title="Insert pg_field_type">pg_field_type(%0, %1);</dialog>

21794

21795

</function>

21796

21797

<description>Free result memory</description>

21798

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21799

21800

<insert>pg_free_result(resource result);</insert>

21801

<dialog title="Insert pg_free_result">pg_free_result(%0);</dialog>

21802

21803

</function>

21804

21805

<description>Ping database connection</description>

21806

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21807

<param name="result_type" required="0" vallist="0" default="" type="int">result_type</param>

21808

<return type="array">array</return>

21809

<insert>pg_get_notify(resource connection [,int result_type]);</insert>

21810

<dialog title="Insert pg_get_notify">pg_get_notify(%0, %1);</dialog>

21811

21812

</function>

21813

21814

<description>Ping database connection</description>

21815

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21816

21817

<insert>pg_get_pid(resource connection);</insert>

21818

21819

21820

</function>

21821

21822

21823

Get asynchronous query result

21824

</description>

21825

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21826

<return type="resource">resource</return>

21827

<insert>pg_get_result([resource connection]);</insert>

21828

<dialog title="Insert pg_get_result">pg_get_result(%0);</dialog>

21829

21830

</function>

21831

21832

21833

Returns the host name associated with the connection

21834

</description>

21835

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21836

<return type="string">string</return>

21837

<insert>pg_host(resource connection);</insert>

21838

21839

21840

</function>

21841

21842

21843

Insert array into table.

21844

</description>

21845

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21846

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21847

<param name="assoc_array" required="1" vallist="0" default="" type="array">assoc_array</param>

21848

<param name="options" required="0" vallist="0" default="" type="int">options</param>

21849

21850

<insert>pg_insert(resource connection, string table_name, array assoc_array [,int options]);</insert>

21851

<dialog title="Insert pg_insert">pg_insert(%0, %1, %2, %3);</dialog>

21852

21853

</function>

21854

21855

<description>Get the last error message string of a connection</description>

21856

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21857

<return type="string">string</return>

21858

<insert>pg_last_error([resource connection]);</insert>

21859

<dialog title="Insert pg_last_error">pg_last_error(%0);</dialog>

21860

21861

</function>

21862

21863

21864

Returns the last notice message from PostgreSQL server

21865

</description>

21866

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21867

<return type="string">string</return>

21868

<insert>pg_last_notice(resource connection);</insert>

21869

<dialog title="Insert pg_last_notice">pg_last_notice(%0);</dialog>

21870

21871

</function>

21872

21873

<description>Returns the last object's oid</description>

21874

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21875

21876

<insert>pg_last_oid(resource result);</insert>

21877

21878

21879

</function>

21880

21881

<description>Close a large object</description>

21882

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21883

21884

<insert>pg_lo_close(resource large_object);</insert>

21885

<dialog title="Insert pg_lo_close">pg_lo_close(%0);</dialog>

21886

21887

</function>

21888

21889

<description>Create a large object</description>

21890

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21891

21892

<insert>pg_lo_create(resource connection);</insert>

21893

<dialog title="Insert pg_lo_create">pg_lo_create(%0);</dialog>

21894

21895

</function>

21896

21897

<description>Export a large object to file</description>

21898

21899

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

21900

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21901

21902

<insert>pg_lo_export(int oid, string pathname [,resource connection]);</insert>

21903

<dialog title="Insert pg_lo_export">pg_lo_export(%0, %1, %2);</dialog>

21904

21905

</function>

21906

21907

<description>Import a large object from file</description>

21908

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

21909

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

21910

21911

<insert>pg_lo_import([resource connection], string pathname);</insert>

21912

<dialog title="Insert pg_lo_import">pg_lo_import(%0, %1);</dialog>

21913

21914

</function>

21915

21916

<description>Open a large object</description>

21917

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21918

21919

21920

<return type="resource">resource</return>

21921

<insert>pg_lo_open(resource connection, int oid, string mode);</insert>

21922

21923

21924

</function>

21925

21926

21927

Read a entire large object and send straight to browser

21928

</description>

21929

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21930

21931

<insert>pg_lo_read_all(resource large_object);</insert>

21932

21933

21934

</function>

21935

21936

<description>Read a large object</description>

21937

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21938

21939

<return type="string">string</return>

21940

<insert>pg_lo_read(resource large_object, int len);</insert>

21941

21942

21943

</function>

21944

21945

21946

Seeks position of large object

21947

</description>

21948

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21949

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

21950

<param name="whence" required="0" vallist="0" default="" type="int">whence</param>

21951

21952

<insert>pg_lo_seek(resource large_object, int offset [,int whence]);</insert>

21953

21954

21955

</function>

21956

21957

21958

Returns current position of large object

21959

</description>

21960

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21961

21962

<insert>pg_lo_tell(resource large_object);</insert>

21963

21964

21965

</function>

21966

21967

<description>Delete a large object</description>

21968

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21969

21970

21971

<insert>pg_lo_unlink(resource connection, int oid);</insert>

21972

<dialog title="Insert pg_lo_unlink">pg_lo_unlink(%0, %1);</dialog>

21973

21974

</function>

21975

21976

<description>Write a large object</description>

21977

<param name="large_object" required="1" vallist="0" default="" type="resource">large_object</param>

21978

21979

21980

<insert>pg_lo_write(resource large_object, string data);</insert>

21981

<dialog title="Insert pg_lo_write">pg_lo_write(%0, %1);</dialog>

21982

21983

</function>

21984

21985

21986

Get meta data for table.

21987

</description>

21988

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

21989

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

21990

<return type="array">array</return>

21991

<insert>pg_meta_data(resource connection, string table_name);</insert>

21992

21993

21994

</function>

21995

21996

<description>Returns the number of fields</description>

21997

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

21998

21999

<insert>pg_num_fields(resource result);</insert>

22000

<dialog title="Insert pg_num_fields">pg_num_fields(%0);</dialog>

22001

22002

</function>

22003

22004

<description>Returns the number of rows</description>

22005

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

22006

22007

<insert>pg_num_rows(resource result);</insert>

22008

22009

22010

</function>

22011

22012

<description>Get the options associated with the connection</description>

22013

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22014

<return type="string">string</return>

22015

<insert>pg_options(resource connection);</insert>

22016

<dialog title="Insert pg_options">pg_options(%0);</dialog>

22017

22018

</function>

22019

22020

<description>Open a persistent PostgreSQL connection</description>

22021

<param name="connection_string" required="1" vallist="0" default="" type="string">connection_string</param>

22022

<return type="resource">resource</return>

22023

<insert>pg_pconnect(string connection_string);</insert>

22024

<dialog title="Insert pg_pconnect">pg_pconnect(%0);</dialog>

22025

22026

</function>

22027

22028

<description>Ping database connection</description>

22029

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22030

22031

<insert>pg_ping(resource connection);</insert>

22032

22033

22034

</function>

22035

22036

22037

Return the port number associated with the connection

22038

</description>

22039

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22040

22041

<insert>pg_port(resource connection);</insert>

22042

22043

22044

</function>

22045

22046

<description>Send a NULL-terminated string to PostgreSQL backend</description>

22047

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

22048

22049

22050

<insert>pg_put_line([resource connection], string data);</insert>

22051

22052

22053

</function>

22054

22055

<description>Execute a query</description>

22056

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22057

<param name="query" required="1" vallist="0" default="" type="string">query</param>

22058

<return type="resource">resource</return>

22059

<insert>pg_query(resource connection, string query);</insert>

22060

<dialog title="Insert pg_query">pg_query(%0, %1);</dialog>

22061

22062

</function>

22063

22064

22065

Get error message associated with result

22066

</description>

22067

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

22068

<return type="string">string</return>

22069

<insert>pg_result_error(resource result);</insert>

22070

<dialog title="Insert pg_result_error">pg_result_error(%0);</dialog>

22071

22072

</function>

22073

22074

<description>Set internal row offset in result resource</description>

22075

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

22076

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

22077

<return type="array">array</return>

22078

<insert>pg_result_seek(resource result, int offset);</insert>

22079

<dialog title="Insert pg_result_seek">pg_result_seek(%0, %1);</dialog>

22080

22081

</function>

22082

22083

22084

Get status of query result

22085

</description>

22086

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

22087

22088

<insert>pg_result_status(resource result);</insert>

22089

<dialog title="Insert pg_result_status">pg_result_status(%0);</dialog>

22090

22091

</function>

22092

22093

22094

Select records.

22095

</description>

22096

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22097

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

22098

<param name="assoc_array" required="1" vallist="0" default="" type="array">assoc_array</param>

22099

<param name="options" required="0" vallist="0" default="" type="int">options</param>

22100

<return type="array">array</return>

22101

<insert>pg_select(resource connection, string table_name, array assoc_array [,int options]);</insert>

22102

<dialog title="Insert pg_select">pg_select(%0, %1, %2, %3);</dialog>

22103

22104

</function>

22105

22106

22107

Send asynchronous query

22108

</description>

22109

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22110

<param name="query" required="1" vallist="0" default="" type="string">query</param>

22111

22112

<insert>pg_send_query(resource connection, string query);</insert>

22113

<dialog title="Insert pg_send_query">pg_send_query(%0, %1);</dialog>

22114

22115

</function>

22116

22117

22118

Set the client encoding

22119

</description>

22120

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

22121

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

22122

22123

<insert>pg_set_client_encoding([resource connection], string encoding);</insert>

22124

<dialog title="Insert pg_set_client_encoding">pg_set_client_encoding(%0, %1);</dialog>

22125

22126

</function>

22127

22128

<description>Enable tracing a PostgreSQL connection</description>

22129

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

22130

22131

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

22132

22133

<insert>pg_trace(string pathname [,string mode] [,resource connection]);</insert>

22134

<dialog title="Insert pg_trace">pg_trace(%0, %1, %2);</dialog>

22135

22136

</function>

22137

22138

22139

Return the tty name associated with the connection

22140

</description>

22141

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22142

<return type="string">string</return>

22143

<insert>pg_tty(resource connection);</insert>

22144

22145

22146

</function>

22147

22148

22149

Escape binary for bytea type

22150

</description>

22151

22152

<return type="string">string</return>

22153

<insert>pg_unescape_bytea(string data);</insert>

22154

<dialog title="Insert pg_unescape_bytea">pg_unescape_bytea(%0);</dialog>

22155

22156

</function>

22157

22158

<description>Disable tracing of a PostgreSQL connection</description>

22159

<param name="connection" required="0" vallist="0" default="" type="resource">connection</param>

22160

22161

<insert>pg_untrace([resource connection]);</insert>

22162

<dialog title="Insert pg_untrace">pg_untrace(%0);</dialog>

22163

22164

</function>

22165

22166

22167

Update table.

22168

</description>

22169

<param name="connection" required="1" vallist="0" default="" type="resource">connection</param>

22170

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

22171

<param name="condition" required="1" vallist="0" default="" type="array">condition</param>

22172

22173

<param name="options" required="0" vallist="0" default="" type="int">options</param>

22174

<return type="mixed">mixed</return>

22175

<insert>pg_update(resource connection, string table_name, array condition, array data [,int options]);</insert>

22176

<dialog title="Insert pg_update">pg_update(%0, %1, %2, %3, %4);</dialog>

22177

22178

</function>

22179

</group>

22180

22181

22182

<description>Get path name of controlling terminal</description>

22183

<return type="string">string</return>

22184

<insert>posix_ctermid();</insert>

22185

<dialog title="Insert posix_ctermid">posix_ctermid();</dialog>

22186

22187

</function>

22188

22189

<description>Pathname of current directory</description>

22190

<return type="string">string</return>

22191

<insert>posix_getcwd();</insert>

22192

<dialog title="Insert posix_getcwd">posix_getcwd();</dialog>

22193

22194

</function>

22195

22196

22197

Return the effective group ID of the current process

22198

</description>

22199

22200

<insert>posix_getegid();</insert>

22201

<dialog title="Insert posix_getegid">posix_getegid();</dialog>

22202

22203

</function>

22204

22205

22206

Return the effective user ID of the current process

22207

</description>

22208

22209

<insert>posix_geteuid();</insert>

22210

<dialog title="Insert posix_geteuid">posix_geteuid();</dialog>

22211

22212

</function>

22213

22214

22215

Return the real group ID of the current process

22216

</description>

22217

22218

<insert>posix_getgid();</insert>

22219

<dialog title="Insert posix_getgid">posix_getgid();</dialog>

22220

22221

</function>

22222

22223

<description>Return info about a group by group id</description>

22224

22225

<return type="array">array</return>

22226

<insert>posix_getgrgid(int gid);</insert>

22227

<dialog title="Insert posix_getgrgid">posix_getgrgid(%0);</dialog>

22228

22229

</function>

22230

22231

<description>Return info about a group by name</description>

22232

22233

<return type="array">array</return>

22234

<insert>posix_getgrnam(string name);</insert>

22235

<dialog title="Insert posix_getgrnam">posix_getgrnam(%0);</dialog>

22236

22237

</function>

22238

22239

22240

Return the group set of the current process

22241

</description>

22242

<return type="array">array</return>

22243

<insert>posix_getgroups();</insert>

22244

<dialog title="Insert posix_getgroups">posix_getgroups();</dialog>

22245

22246

</function>

22247

22248

<description>Return login name</description>

22249

<return type="string">string</return>

22250

<insert>posix_getlogin();</insert>

22251

<dialog title="Insert posix_getlogin">posix_getlogin();</dialog>

22252

22253

</function>

22254

22255

<description>Get process group id for job control</description>

22256

22257

22258

<insert>posix_getpgid(int pid);</insert>

22259

<dialog title="Insert posix_getpgid">posix_getpgid(%0);</dialog>

22260

22261

</function>

22262

22263

22264

Return the current process group identifier

22265

</description>

22266

22267

<insert>posix_getpgrp();</insert>

22268

<dialog title="Insert posix_getpgrp">posix_getpgrp();</dialog>

22269

22270

</function>

22271

22272

<description>Return the current process identifier</description>

22273

22274

<insert>posix_getpid();</insert>

22275

<dialog title="Insert posix_getpid">posix_getpid();</dialog>

22276

22277

</function>

22278

22279

<description>Return the parent process identifier</description>

22280

22281

<insert>posix_getppid();</insert>

22282

<dialog title="Insert posix_getppid">posix_getppid();</dialog>

22283

22284

</function>

22285

22286

<description>Return info about a user by username</description>

22287

<param name="username" required="1" vallist="0" default="" type="string">username</param>

22288

<return type="array">array</return>

22289

<insert>posix_getpwnam(string username);</insert>

22290

<dialog title="Insert posix_getpwnam">posix_getpwnam(%0);</dialog>

22291

22292

</function>

22293

22294

<description>Return info about a user by user id</description>

22295

22296

<return type="array">array</return>

22297

<insert>posix_getpwuid(int uid);</insert>

22298

<dialog title="Insert posix_getpwuid">posix_getpwuid(%0);</dialog>

22299

22300

</function>

22301

22302

<description>Return info about system ressource limits</description>

22303

<return type="array">array</return>

22304

<insert>posix_getrlimit();</insert>

22305

<dialog title="Insert posix_getrlimit">posix_getrlimit();</dialog>

22306

22307

</function>

22308

22309

<description>Get the current sid of the process</description>

22310

22311

22312

<insert>posix_getsid(int pid);</insert>

22313

<dialog title="Insert posix_getsid">posix_getsid(%0);</dialog>

22314

22315

</function>

22316

22317

22318

Return the real user ID of the current process

22319

</description>

22320

22321

<insert>posix_getuid();</insert>

22322

<dialog title="Insert posix_getuid">posix_getuid();</dialog>

22323

22324

</function>

22325

22326

22327

Determine if a file descriptor is an interactive terminal

22328

</description>

22329

22330

22331

<insert>posix_isatty(int fd);</insert>

22332

<dialog title="Insert posix_isatty">posix_isatty(%0);</dialog>

22333

22334

</function>

22335

22336

<description>Send a signal to a process</description>

22337

22338

22339

22340

<insert>posix_kill(int pid, int sig);</insert>

22341

<dialog title="Insert posix_kill">posix_kill(%0, %1);</dialog>

22342

22343

</function>

22344

22345

22346

Create a fifo special file (a named pipe)

22347

</description>

22348

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

22349

22350

22351

<insert>posix_mkfifo(string pathname, int mode);</insert>

22352

<dialog title="Insert posix_mkfifo">posix_mkfifo(%0, %1);</dialog>

22353

22354

</function>

22355

22356

22357

Set the effective GID of the current process

22358

</description>

22359

22360

22361

<insert>posix_setegid(int gid);</insert>

22362

<dialog title="Insert posix_setegid">posix_setegid(%0);</dialog>

22363

22364

</function>

22365

22366

22367

Set the effective UID of the current process

22368

</description>

22369

22370

22371

<insert>posix_seteuid(int uid);</insert>

22372

<dialog title="Insert posix_seteuid">posix_seteuid(%0);</dialog>

22373

22374

</function>

22375

22376

22377

Set the GID of the current process

22378

</description>

22379

22380

22381

<insert>posix_setgid(int gid);</insert>

22382

<dialog title="Insert posix_setgid">posix_setgid(%0);</dialog>

22383

22384

</function>

22385

22386

<description>set process group id for job control</description>

22387

22388

22389

22390

<insert>posix_setpgid(int pid, int pgid);</insert>

22391

<dialog title="Insert posix_setpgid">posix_setpgid(%0, %1);</dialog>

22392

22393

</function>

22394

22395

<description>Make the current process a session leader</description>

22396

22397

<insert>posix_setsid();</insert>

22398

<dialog title="Insert posix_setsid">posix_setsid();</dialog>

22399

22400

</function>

22401

22402

22403

Set the UID of the current process

22404

</description>

22405

22406

22407

<insert>posix_setuid(int uid);</insert>

22408

<dialog title="Insert posix_setuid">posix_setuid(%0);</dialog>

22409

22410

</function>

22411

22412

<description>Get process times</description>

22413

<return type="array">array</return>

22414

<insert>posix_times();</insert>

22415

<dialog title="Insert posix_times">posix_times();</dialog>

22416

22417

</function>

22418

22419

<description>Determine terminal device name</description>

22420

22421

<return type="string">string</return>

22422

<insert>posix_ttyname(int fd);</insert>

22423

<dialog title="Insert posix_ttyname">posix_ttyname(%0);</dialog>

22424

22425

</function>

22426

22427

<description>Get system name</description>

22428

<return type="array">array</return>

22429

<insert>posix_uname();</insert>

22430

<dialog title="Insert posix_uname">posix_uname();</dialog>

22431

22432

</function>

22433

</group>

22434

22435

22436

<description>Deletes the printer's spool file</description>

22437

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22438

22439

<insert>printer_abort(resource handle);</insert>

22440

<dialog title="Insert printer_abort">printer_abort(%0);</dialog>

22441

22442

</function>

22443

22444

<description>Close an open printer connection</description>

22445

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22446

22447

<insert>printer_close(resource handle);</insert>

22448

<dialog title="Insert printer_close">printer_close(%0);</dialog>

22449

22450

</function>

22451

22452

<description>Create a new brush</description>

22453

<param name="style" required="1" vallist="0" default="" type="int">style</param>

22454

<param name="color" required="1" vallist="0" default="" type="string">color</param>

22455

<return type="mixed">mixed</return>

22456

<insert>printer_create_brush(int style, string color);</insert>

22457

<dialog title="Insert printer_create_brush">printer_create_brush(%0, %1);</dialog>

22458

22459

</function>

22460

22461

<description>Create a new device context</description>

22462

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22463

22464

<insert>printer_create_dc(resource handle);</insert>

22465

<dialog title="Insert printer_create_dc">printer_create_dc(%0);</dialog>

22466

22467

</function>

22468

22469

<description>Create a new font</description>

22470

22471

<param name="height" required="1" vallist="0" default="" type="int">height</param>

22472

<param name="width" required="1" vallist="0" default="" type="int">width</param>

22473

<param name="font_weight" required="1" vallist="0" default="" type="int">font_weight</param>

22474

<param name="italic" required="1" vallist="0" default="" type="bool">italic</param>

22475

<param name="underline" required="1" vallist="0" default="" type="bool">underline</param>

22476

<param name="strikeout" required="1" vallist="0" default="" type="bool">strikeout</param>

22477

<param name="orientaton" required="1" vallist="0" default="" type="int">orientaton</param>

22478

<return type="mixed">mixed</return>

22479

<insert>printer_create_font(string face, int height, int width, int font_weight, bool italic, bool underline, bool strikeout, int orientaton);</insert>

22480

<dialog title="Insert printer_create_font">printer_create_font(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

22481

22482

</function>

22483

22484

<description>Create a new pen</description>

22485

<param name="style" required="1" vallist="0" default="" type="int">style</param>

22486

<param name="width" required="1" vallist="0" default="" type="int">width</param>

22487

<param name="color" required="1" vallist="0" default="" type="string">color</param>

22488

<return type="mixed">mixed</return>

22489

<insert>printer_create_pen(int style, int width, string color);</insert>

22490

<dialog title="Insert printer_create_pen">printer_create_pen(%0, %1, %2);</dialog>

22491

22492

</function>

22493

22494

<description>Delete a brush</description>

22495

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22496

22497

<insert>printer_delete_brush(resource handle);</insert>

22498

<dialog title="Insert printer_delete_brush">printer_delete_brush(%0);</dialog>

22499

22500

</function>

22501

22502

<description>Delete a device context</description>

22503

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22504

22505

<insert>printer_delete_dc(resource handle);</insert>

22506

<dialog title="Insert printer_delete_dc">printer_delete_dc(%0);</dialog>

22507

22508

</function>

22509

22510

<description>Delete a font</description>

22511

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22512

22513

<insert>printer_delete_font(resource handle);</insert>

22514

<dialog title="Insert printer_delete_font">printer_delete_font(%0);</dialog>

22515

22516

</function>

22517

22518

<description>Delete a pen</description>

22519

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22520

22521

<insert>printer_delete_pen(resource handle);</insert>

22522

<dialog title="Insert printer_delete_pen">printer_delete_pen(%0);</dialog>

22523

22524

</function>

22525

22526

22527

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22528

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

22529

22530

22531

22532

<insert>printer_draw_bmp(resource handle, string filename, int x, int y);</insert>

22533

<dialog title="Insert printer_draw_bmp">printer_draw_bmp(%0, %1, %2, %3);</dialog>

22534

22535

</function>

22536

22537

<description>Draw a chord</description>

22538

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22539

22540

22541

22542

22543

22544

22545

22546

22547

22548

<insert>printer_draw_chord(resource handle, int rec_x, int rec_y, int rec_x1, int rec_y1, int rad_x, int rad_y, int rad_x1, int rad_y1);</insert>

22549

<dialog title="Insert printer_draw_chord">printer_draw_chord(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

22550

22551

</function>

22552

22553

<description>Draw an ellipse</description>

22554

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22555

22556

22557

22558

22559

22560

<insert>printer_draw_elipse(resource handle, int ul_x, int ul_y, int lr_x, int lr_y);</insert>

22561

<dialog title="Insert printer_draw_elipse">printer_draw_elipse(%0, %1, %2, %3, %4);</dialog>

22562

22563

</function>

22564

22565

22566

<param name="printer_handle" required="1" vallist="0" default="" type="resource">printer_handle</param>

22567

22568

22569

22570

22571

22572

<insert>printer_draw_line(resource printer_handle, int from_x, int from_y, int to_x, int to_y);</insert>

22573

<dialog title="Insert printer_draw_line">printer_draw_line(%0, %1, %2, %3, %4);</dialog>

22574

22575

</function>

22576

22577

22578

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22579

22580

22581

22582

22583

22584

22585

22586

22587

22588

<insert>printer_draw_pie(resource handle, int rec_x, int rec_y, int rec_x1, int rec_y1, int rad1_x, int rad1_y, int rad2_x, int rad2_y);</insert>

22589

<dialog title="Insert printer_draw_pie">printer_draw_pie(%0, %1, %2, %3, %4, %5, %6, %7, %8);</dialog>

22590

22591

</function>

22592

22593

<description>Draw a rectangle</description>

22594

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22595

22596

22597

22598

22599

22600

<insert>printer_draw_rectangle(resource handle, int ul_x, int ul_y, int lr_x, int lr_y);</insert>

22601

<dialog title="Insert printer_draw_rectangle">printer_draw_rectangle(%0, %1, %2, %3, %4);</dialog>

22602

22603

</function>

22604

22605

<description>Draw a rectangle with rounded corners</description>

22606

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22607

22608

22609

22610

22611

<param name="width" required="1" vallist="0" default="" type="int">width</param>

22612

<param name="height" required="1" vallist="0" default="" type="int">height</param>

22613

22614

<insert>printer_draw_roundrect(resource handle, int ul_x, int ul_y, int lr_x, int lr_y, int width, int height);</insert>

22615

<dialog title="Insert printer_draw_roundrect">printer_draw_roundrect(%0, %1, %2, %3, %4, %5, %6);</dialog>

22616

22617

</function>

22618

22619

22620

<param name="printer_handle" required="1" vallist="0" default="" type="resource">printer_handle</param>

22621

22622

22623

22624

22625

<insert>printer_draw_text(resource printer_handle, string text, int x, int y);</insert>

22626

<dialog title="Insert printer_draw_text">printer_draw_text(%0, %1, %2, %3);</dialog>

22627

22628

</function>

22629

22630

<description>Close document</description>

22631

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22632

22633

<insert>printer_end_doc(resource handle);</insert>

22634

<dialog title="Insert printer_end_doc">printer_end_doc(%0);</dialog>

22635

22636

</function>

22637

22638

<description>Close active page</description>

22639

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22640

22641

<insert>printer_end_page(resource handle);</insert>

22642

<dialog title="Insert printer_end_page">printer_end_page(%0);</dialog>

22643

22644

</function>

22645

22646

<description>Retrieve printer configuration data</description>

22647

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22648

<param name="option" required="1" vallist="0" default="" type="string">option</param>

22649

<return type="mixed">mixed</return>

22650

<insert>printer_get_option(resource handle, string option);</insert>

22651

<dialog title="Insert printer_get_option">printer_get_option(%0, %1);</dialog>

22652

22653

</function>

22654

22655

<description>Return an array of printers attached to the server

22656

</description>

22657

<param name="enumtype" required="1" vallist="0" default="" type="int">enumtype</param>

22658

22659

<param name="level" required="0" vallist="0" default="" type="int">level</param>

22660

<return type="array">array</return>

22661

<insert>printer_list(int enumtype [,string name] [,int level]);</insert>

22662

<dialog title="Insert printer_list">printer_list(%0, %1, %2);</dialog>

22663

22664

</function>

22665

22666

<description>Get logical font height</description>

22667

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22668

<param name="height" required="1" vallist="0" default="" type="int">height</param>

22669

22670

<insert>printer_logical_fontheight(resource handle, int height);</insert>

22671

<dialog title="Insert printer_logical_fontheight">printer_logical_fontheight(%0, %1);</dialog>

22672

22673

</function>

22674

22675

<description>Open connection to a printer</description>

22676

<param name="devicename" required="0" vallist="0" default="" type="string">devicename</param>

22677

<return type="mixed">mixed</return>

22678

<insert>printer_open([string devicename]);</insert>

22679

<dialog title="Insert printer_open">printer_open(%0);</dialog>

22680

22681

</function>

22682

22683

<description>Select a brush</description>

22684

<param name="printer_handle" required="1" vallist="0" default="" type="resource">printer_handle</param>

22685

<param name="brush_handle" required="1" vallist="0" default="" type="resource">brush_handle</param>

22686

22687

<insert>printer_select_brush(resource printer_handle, resource brush_handle);</insert>

22688

<dialog title="Insert printer_select_brush">printer_select_brush(%0, %1);</dialog>

22689

22690

</function>

22691

22692

<description>Select a font</description>

22693

<param name="printer_handle" required="1" vallist="0" default="" type="resource">printer_handle</param>

22694

<param name="font_handle" required="1" vallist="0" default="" type="resource">font_handle</param>

22695

22696

<insert>printer_select_font(resource printer_handle, resource font_handle);</insert>

22697

<dialog title="Insert printer_select_font">printer_select_font(%0, %1);</dialog>

22698

22699

</function>

22700

22701

<description>Select a pen</description>

22702

<param name="printer_handle" required="1" vallist="0" default="" type="resource">printer_handle</param>

22703

<param name="pen_handle" required="1" vallist="0" default="" type="resource">pen_handle</param>

22704

22705

<insert>printer_select_pen(resource printer_handle, resource pen_handle);</insert>

22706

<dialog title="Insert printer_select_pen">printer_select_pen(%0, %1);</dialog>

22707

22708

</function>

22709

22710

<description>Configure the printer connection</description>

22711

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22712

<param name="option" required="1" vallist="0" default="" type="int">option</param>

22713

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

22714

22715

<insert>printer_set_option(resource handle, int option, mixed value);</insert>

22716

<dialog title="Insert printer_set_option">printer_set_option(%0, %1, %2);</dialog>

22717

22718

</function>

22719

22720

<description>Start a new document</description>

22721

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22722

<param name="document" required="0" vallist="0" default="" type="string">document</param>

22723

22724

<insert>printer_start_doc(resource handle [,string document]);</insert>

22725

<dialog title="Insert printer_start_doc">printer_start_doc(%0, %1);</dialog>

22726

22727

</function>

22728

22729

<description>Start a new page</description>

22730

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22731

22732

<insert>printer_start_page(resource handle);</insert>

22733

<dialog title="Insert printer_start_page">printer_start_page(%0);</dialog>

22734

22735

</function>

22736

22737

<description>Write data to the printer</description>

22738

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

22739

<param name="content" required="1" vallist="0" default="" type="string">content</param>

22740

22741

<insert>printer_write(resource handle, string content);</insert>

22742

<dialog title="Insert printer_write">printer_write(%0, %1);</dialog>

22743

22744

</function>

22745

</group>

22746

22747

22748

<description>Add the word to a personal wordlist</description>

22749

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22750

22751

22752

<insert>pspell_add_to_personal(int dictionary_link, string word);</insert>

22753

<dialog title="Insert pspell_add_to_personal">pspell_add_to_personal(%0, %1);</dialog>

22754

22755

</function>

22756

22757

<description>Add the word to the wordlist in the current session

22758

</description>

22759

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22760

22761

22762

<insert>pspell_add_to_session(int dictionary_link, string word);</insert>

22763

<dialog title="Insert pspell_add_to_session">pspell_add_to_session(%0, %1);</dialog>

22764

22765

</function>

22766

22767

<description>Check a word</description>

22768

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22769

22770

22771

<insert>pspell_check(int dictionary_link, string word);</insert>

22772

<dialog title="Insert pspell_check">pspell_check(%0, %1);</dialog>

22773

22774

</function>

22775

22776

<description>Clear the current session</description>

22777

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22778

22779

<insert>pspell_clear_session(int dictionary_link);</insert>

22780

<dialog title="Insert pspell_clear_session">pspell_clear_session(%0);</dialog>

22781

22782

</function>

22783

22784

<description>Create a config used to open a dictionary</description>

22785

<param name="language" required="1" vallist="0" default="" type="string">language</param>

22786

<param name="

22787

spelling

22788

" required="0" vallist="0" default="" type="string">

22789

spelling

22790

</param>

22791

<param name="

22792

jargon

22793

" required="0" vallist="0" default="" type="string">

22794

jargon

22795

</param>

22796

<param name="

22797

encoding

22798

" required="0" vallist="0" default="" type="string">

22799

encoding

22800

</param>

22801

22802

<insert>pspell_config_create(string language [,string

22803

spelling

22804

] [,string

22805

jargon

22806

] [,string

22807

encoding

22808

]);</insert>

22809

<dialog title="Insert pspell_config_create">pspell_config_create(%0, %1, %2, %3);</dialog>

22810

22811

</function>

22812

22813

<description>Ignore words less than N characters long</description>

22814

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22815

22816

22817

<insert>pspell_config_ignore(int dictionary_link, int n);</insert>

22818

<dialog title="Insert pspell_config_ignore">pspell_config_ignore(%0, %1);</dialog>

22819

22820

</function>

22821

22822

<description>Change the mode number of suggestions returned</description>

22823

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22824

22825

22826

<insert>pspell_config_mode(int dictionary_link, int mode);</insert>

22827

<dialog title="Insert pspell_config_mode">pspell_config_mode(%0, %1);</dialog>

22828

22829

</function>

22830

22831

<description>Set a file that contains personal wordlist</description>

22832

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22833

22834

22835

<insert>pspell_config_personal(int dictionary_link, string file);</insert>

22836

<dialog title="Insert pspell_config_personal">pspell_config_personal(%0, %1);</dialog>

22837

22838

</function>

22839

22840

<description>Set a file that contains replacement pairs</description>

22841

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22842

22843

22844

<insert>pspell_config_repl(int dictionary_link, string file);</insert>

22845

<dialog title="Insert pspell_config_repl">pspell_config_repl(%0, %1);</dialog>

22846

22847

</function>

22848

22849

<description>Consider run-together words as valid compounds</description>

22850

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22851

22852

22853

<insert>pspell_config_runtogether(int dictionary_link, bool flag);</insert>

22854

<dialog title="Insert pspell_config_runtogether">pspell_config_runtogether(%0, %1);</dialog>

22855

22856

</function>

22857

22858

<description>Determine whether to save a replacement pairs list

22859

along with the wordlist</description>

22860

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22861

22862

22863

<insert>pspell_config_save_repl(int dictionary_link, bool flag);</insert>

22864

<dialog title="Insert pspell_config_save_repl">pspell_config_save_repl(%0, %1);</dialog>

22865

22866

</function>

22867

22868

<description>Load a new dictionary with settings based on a given config

22869

</description>

22870

<param name="config" required="1" vallist="0" default="" type="int">config</param>

22871

22872

<insert>pspell_new_config(int config);</insert>

22873

<dialog title="Insert pspell_new_config">pspell_new_config(%0);</dialog>

22874

22875

</function>

22876

22877

<description>Load a new dictionary with personal wordlist</description>

22878

<param name="personal" required="1" vallist="0" default="" type="string">personal</param>

22879

<param name="language" required="1" vallist="0" default="" type="string">language</param>

22880

<param name="

22881

spelling

22882

" required="0" vallist="0" default="" type="string">

22883

spelling

22884

</param>

22885

<param name="

22886

jargon

22887

" required="0" vallist="0" default="" type="string">

22888

jargon

22889

</param>

22890

<param name="

22891

encoding

22892

" required="0" vallist="0" default="" type="string">

22893

encoding

22894

</param>

22895

<param name="

22896

mode

22897

" required="0" vallist="0" default="" type="int">

22898

mode

22899

</param>

22900

22901

<insert>pspell_new_personal(string personal, string language [,string

22902

spelling

22903

] [,string

22904

jargon

22905

] [,string

22906

encoding

22907

] [,int

22908

mode

22909

]);</insert>

22910

<dialog title="Insert pspell_new_personal">pspell_new_personal(%0, %1, %2, %3, %4, %5);</dialog>

22911

22912

</function>

22913

22914

<description>Load a new dictionary</description>

22915

<param name="language" required="1" vallist="0" default="" type="string">language</param>

22916

<param name="

22917

spelling

22918

" required="0" vallist="0" default="" type="string">

22919

spelling

22920

</param>

22921

<param name="

22922

jargon

22923

" required="0" vallist="0" default="" type="string">

22924

jargon

22925

</param>

22926

<param name="

22927

encoding

22928

" required="0" vallist="0" default="" type="string">

22929

encoding

22930

</param>

22931

<param name="

22932

mode

22933

" required="0" vallist="0" default="" type="int">

22934

mode

22935

</param>

22936

22937

<insert>pspell_new(string language [,string

22938

spelling

22939

] [,string

22940

jargon

22941

] [,string

22942

encoding

22943

] [,int

22944

mode

22945

]);</insert>

22946

<dialog title="Insert pspell_new">pspell_new(%0, %1, %2, %3, %4);</dialog>

22947

22948

</function>

22949

22950

<description>Save the personal wordlist to a file</description>

22951

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22952

22953

<insert>pspell_save_wordlist(int dictionary_link);</insert>

22954

<dialog title="Insert pspell_save_wordlist">pspell_save_wordlist(%0);</dialog>

22955

22956

</function>

22957

22958

<description>Store a replacement pair for a word</description>

22959

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22960

<param name="misspelled" required="1" vallist="0" default="" type="string">misspelled</param>

22961

<param name="correct" required="1" vallist="0" default="" type="string">correct</param>

22962

22963

<insert>pspell_store_replacement(int dictionary_link, string misspelled, string correct);</insert>

22964

<dialog title="Insert pspell_store_replacement">pspell_store_replacement(%0, %1, %2);</dialog>

22965

22966

</function>

22967

22968

<description>Suggest spellings of a word</description>

22969

<param name="dictionary_link" required="1" vallist="0" default="" type="int">dictionary_link</param>

22970

22971

<return type="array">array</return>

22972

<insert>pspell_suggest(int dictionary_link, string word);</insert>

22973

<dialog title="Insert pspell_suggest">pspell_suggest(%0, %1);</dialog>

22974

22975

</function>

22976

</group>

22977

22978

22979

<description>Returns the error string from the last QDOM operation or FALSE if no errors occured</description>

22980

<return type="string">string</return>

22981

<insert>qdom_error();</insert>

22982

<dialog title="Insert qdom_error">qdom_error();</dialog>

22983

22984

</function>

22985

22986

<description>creates a tree of an xml string</description>

22987

<return type="object">object</return>

22988

22989

22990

22991

</function>

22992

</group>

22993

22994

22995

<description>Adds a line to the history</description>

22996

22997

22998

<insert>readline_add_history(string line);</insert>

22999

<dialog title="Insert readline_add_history">readline_add_history(%0);</dialog>

23000

23001

</function>

23002

23003

<description>Clears the history</description>

23004

23005

<insert>readline_clear_history();</insert>

23006

<dialog title="Insert readline_clear_history">readline_clear_history();</dialog>

23007

23008

</function>

23009

23010

<description>Registers a completion function</description>

23011

23012

23013

<insert>readline_completion_function(string line);</insert>

23014

<dialog title="Insert readline_completion_function">readline_completion_function(%0);</dialog>

23015

23016

</function>

23017

23018

<description>Gets/sets various internal readline variables</description>

23019

<param name="varname" required="0" vallist="0" default="" type="string">varname</param>

23020

<param name="newvalue" required="0" vallist="0" default="" type="string">newvalue</param>

23021

<return type="mixed">mixed</return>

23022

<insert>readline_info([string varname] [,string newvalue]);</insert>

23023

<dialog title="Insert readline_info">readline_info(%0, %1);</dialog>

23024

23025

</function>

23026

23027

<description>Lists the history</description>

23028

<return type="array">array</return>

23029

<insert>readline_list_history();</insert>

23030

<dialog title="Insert readline_list_history">readline_list_history();</dialog>

23031

23032

</function>

23033

23034

<description>Reads the history</description>

23035

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

23036

23037

<insert>readline_read_history(string filename);</insert>

23038

<dialog title="Insert readline_read_history">readline_read_history(%0);</dialog>

23039

23040

</function>

23041

23042

<description>Writes the history</description>

23043

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

23044

23045

<insert>readline_write_history(string filename);</insert>

23046

<dialog title="Insert readline_write_history">readline_write_history(%0);</dialog>

23047

23048

</function>

23049

23050

<description>Reads a line</description>

23051

<param name="prompt" required="0" vallist="0" default="" type="string">prompt</param>

23052

<return type="string">string</return>

23053

<insert>readline([string prompt]);</insert>

23054

<dialog title="Insert readline">readline(%0);</dialog>

23055

23056

</function>

23057

</group>

23058

23059

23060

23061

Recode from file to file according to recode request

23062

</description>

23063

<param name="request" required="1" vallist="0" default="" type="string">request</param>

23064

<param name="input" required="1" vallist="0" default="" type="resource">input</param>

23065

<param name="output" required="1" vallist="0" default="" type="resource">output</param>

23066

23067

<insert>recode_file(string request, resource input, resource output);</insert>

23068

<dialog title="Insert recode_file">recode_file(%0, %1, %2);</dialog>

23069

23070

</function>

23071

23072

<description>Recode a string according to a recode request</description>

23073

<param name="request" required="1" vallist="0" default="" type="string">request</param>

23074

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23075

<return type="string">string</return>

23076

<insert>recode_string(string request, string string);</insert>

23077

<dialog title="Insert recode_string">recode_string(%0, %1);</dialog>

23078

23079

</function>

23080

</group>

23081

23082

23083

<description>Replace regular expression</description>

23084

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23085

<param name="replacement" required="1" vallist="0" default="" type="string">replacement</param>

23086

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23087

<return type="string">string</return>

23088

<insert>ereg_replace(string pattern, string replacement, string string);</insert>

23089

<dialog title="Insert ereg_replace">ereg_replace(%0, %1, %2);</dialog>

23090

23091

</function>

23092

23093

<description>Regular expression match</description>

23094

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23095

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23096

23097

23098

<insert>ereg(string pattern, string string [,array regs]);</insert>

23099

23100

23101

</function>

23102

23103

<description>replace regular expression case insensitive</description>

23104

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23105

<param name="replacement" required="1" vallist="0" default="" type="string">replacement</param>

23106

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23107

<return type="string">string</return>

23108

<insert>eregi_replace(string pattern, string replacement, string string);</insert>

23109

<dialog title="Insert eregi_replace">eregi_replace(%0, %1, %2);</dialog>

23110

23111

</function>

23112

23113

<description>case insensitive regular expression match</description>

23114

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23115

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23116

23117

23118

<insert>eregi(string pattern, string string [,array regs]);</insert>

23119

<dialog title="Insert eregi">eregi(%0, %1, %2);</dialog>

23120

23121

</function>

23122

23123

<description>split string into array by regular expression</description>

23124

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23125

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23126

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

23127

<return type="array">array</return>

23128

<insert>split(string pattern, string string [,int limit]);</insert>

23129

<dialog title="Insert split">split(%0, %1, %2);</dialog>

23130

23131

</function>

23132

23133

23134

Split string into array by regular expression case insensitive

23135

</description>

23136

<param name="pattern" required="1" vallist="0" default="" type="string">pattern</param>

23137

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23138

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

23139

<return type="array">array</return>

23140

<insert>spliti(string pattern, string string [,int limit]);</insert>

23141

<dialog title="Insert spliti">spliti(%0, %1, %2);</dialog>

23142

23143

</function>

23144

23145

23146

Make regular expression for case insensitive match

23147

</description>

23148

<param name="string" required="1" vallist="0" default="" type="string">string</param>

23149

<return type="string">string</return>

23150

<insert>sql_regcase(string string);</insert>

23151

<dialog title="Insert sql_regcase">sql_regcase(%0);</dialog>

23152

23153

</function>

23154

</group>

23155

23156

23157

23158

Convert a pathname and a project identifier to a System V IPC key

23159

</description>

23160

<param name="pathname" required="1" vallist="0" default="" type="string">pathname</param>

23161

23162

23163

<insert>ftok(string pathname, string proj);</insert>

23164

23165

23166

</function>

23167

23168

23169

Create or attach to a message queue

23170

</description>

23171

23172

<param name="perms" required="0" vallist="0" default="" type="int">perms</param>

23173

23174

<insert>msg_get_queue(int key [,int perms]);</insert>

23175

<dialog title="Insert msg_get_queue">msg_get_queue(%0, %1);</dialog>

23176

23177

</function>

23178

23179

23180

Receive a message from a message queue

23181

</description>

23182

<param name="queue" required="1" vallist="0" default="" type="int">queue</param>

23183

<param name="desiredmsgtype" required="1" vallist="0" default="" type="int">desiredmsgtype</param>

23184

<param name="msgtype" required="1" vallist="0" default="" type="int">msgtype</param>

23185

<param name="maxsize" required="1" vallist="0" default="" type="int">maxsize</param>

23186

<param name="message" required="1" vallist="0" default="" type="mixed">message</param>

23187

<param name="unserialize" required="0" vallist="0" default="" type="bool">unserialize</param>

23188

<param name="flags" required="0" vallist="0" default="" type="int">flags</param>

23189

<param name="errorcode" required="0" vallist="0" default="" type="int">errorcode</param>

23190

23191

<insert>msg_receive(int queue, int desiredmsgtype, int msgtype, int maxsize, mixed message [,bool unserialize] [,int flags] [,int errorcode]);</insert>

23192

<dialog title="Insert msg_receive">msg_receive(%0, %1, %2, %3, %4, %5, %6, %7);</dialog>

23193

23194

</function>

23195

23196

23197

Destroy a message queue

23198

</description>

23199

<param name="queue" required="1" vallist="0" default="" type="int">queue</param>

23200

23201

<insert>msg_remove_queue(int queue);</insert>

23202

<dialog title="Insert msg_remove_queue">msg_remove_queue(%0);</dialog>

23203

23204

</function>

23205

23206

23207

Send a message to a message queue

23208

</description>

23209

<param name="queue" required="1" vallist="0" default="" type="int">queue</param>

23210

<param name="msgtype" required="1" vallist="0" default="" type="int">msgtype</param>

23211

<param name="message" required="1" vallist="0" default="" type="mixed">message</param>

23212

<param name="serialize" required="0" vallist="0" default="" type="bool">serialize</param>

23213

<param name="blocking" required="0" vallist="0" default="" type="bool">blocking</param>

23214

<param name="errorcode" required="0" vallist="0" default="" type="int">errorcode</param>

23215

23216

<insert>msg_send(int queue, int msgtype, mixed message [,bool serialize] [,bool blocking] [,int errorcode]);</insert>

23217

23218

23219

</function>

23220

23221

23222

Set information in the message queue data structure

23223

</description>

23224

<param name="queue" required="1" vallist="0" default="" type="int">queue</param>

23225

23226

23227

<insert>msg_set_queue(int queue, array data);</insert>

23228

<dialog title="Insert msg_set_queue">msg_set_queue(%0, %1);</dialog>

23229

23230

</function>

23231

23232

23233

Returns information from the message queue data structure

23234

</description>

23235

<param name="queue" required="1" vallist="0" default="" type="int">queue</param>

23236

<return type="array">array</return>

23237

<insert>msg_stat_queue(int queue);</insert>

23238

<dialog title="Insert msg_stat_queue">msg_stat_queue(%0);</dialog>

23239

23240

</function>

23241

23242

<description>Acquire a semaphore</description>

23243

<param name="sem_identifier" required="1" vallist="0" default="" type="int">sem_identifier</param>

23244

23245

<insert>sem_acquire(int sem_identifier);</insert>

23246

<dialog title="Insert sem_acquire">sem_acquire(%0);</dialog>

23247

23248

</function>

23249

23250

<description>Get a semaphore id</description>

23251

23252

<param name="max_acquire" required="0" vallist="0" default="" type="int">max_acquire</param>

23253

23254

23255

<insert>sem_get(int key [,int max_acquire] [,int perm]);</insert>

23256

23257

23258

</function>

23259

23260

<description>Release a semaphore</description>

23261

<param name="sem_identifier" required="1" vallist="0" default="" type="int">sem_identifier</param>

23262

23263

<insert>sem_release(int sem_identifier);</insert>

23264

<dialog title="Insert sem_release">sem_release(%0);</dialog>

23265

23266

</function>

23267

23268

<description>Remove a semaphore</description>

23269

<param name="sem_identifier" required="1" vallist="0" default="" type="int">sem_identifier</param>

23270

23271

<insert>sem_remove(int sem_identifier);</insert>

23272

<dialog title="Insert sem_remove">sem_remove(%0);</dialog>

23273

23274

</function>

23275

23276

<description>Creates or open a shared memory segment</description>

23277

23278

<param name="memsize" required="0" vallist="0" default="" type="int">memsize</param>

23279

23280

23281

<insert>shm_attach(int key [,int memsize] [,int perm]);</insert>

23282

<dialog title="Insert shm_attach">shm_attach(%0, %1, %2);</dialog>

23283

23284

</function>

23285

23286

<description>Disconnects from shared memory segment</description>

23287

<param name="shm_identifier" required="1" vallist="0" default="" type="int">shm_identifier</param>

23288

23289

<insert>shm_detach(int shm_identifier);</insert>

23290

<dialog title="Insert shm_detach">shm_detach(%0);</dialog>

23291

23292

</function>

23293

23294

<description>Returns a variable from shared memory</description>

23295

23296

<param name="variable_key" required="1" vallist="0" default="" type="int">variable_key</param>

23297

<return type="mixed">mixed</return>

23298

<insert>shm_get_var(int id, int variable_key);</insert>

23299

23300

23301

</function>

23302

23303

<description>Inserts or updates a variable in shared

23304

memory</description>

23305

<param name="shm_identifier" required="1" vallist="0" default="" type="int">shm_identifier</param>

23306

<param name="variable_key" required="1" vallist="0" default="" type="int">variable_key</param>

23307

<param name="variable" required="1" vallist="0" default="" type="mixed">variable</param>

23308

23309

<insert>shm_put_var(int shm_identifier, int variable_key, mixed variable);</insert>

23310

23311

23312

</function>

23313

23314

<description>Removes a variable from shared memory

23315

</description>

23316

23317

<param name="variable_key" required="1" vallist="0" default="" type="int">variable_key</param>

23318

23319

<insert>shm_remove_var(int id, int variable_key);</insert>

23320

<dialog title="Insert shm_remove_var">shm_remove_var(%0, %1);</dialog>

23321

23322

</function>

23323

23324

<description>Removes shared memory from Unix systems</description>

23325

<param name="shm_identifier" required="1" vallist="0" default="" type="int">shm_identifier</param>

23326

23327

<insert>shm_remove(int shm_identifier);</insert>

23328

<dialog title="Insert shm_remove">shm_remove(%0);</dialog>

23329

23330

</function>

23331

</group>

23332

23333

23334

23335

Get number of rows affected by an immediate query

23336

</description>

23337

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23338

23339

<insert>sesam_affected_rows(string result_id);</insert>

23340

<dialog title="Insert sesam_affected_rows">sesam_affected_rows(%0);</dialog>

23341

23342

</function>

23343

23344

23345

Commit pending updates to the SESAM database

23346

</description>

23347

23348

<insert>sesam_commit();</insert>

23349

<dialog title="Insert sesam_commit">sesam_commit();</dialog>

23350

23351

</function>

23352

23353

<description>Open SESAM database connection</description>

23354

<param name="catalog" required="1" vallist="0" default="" type="string">catalog</param>

23355

<param name="schema" required="1" vallist="0" default="" type="string">schema</param>

23356

23357

23358

<insert>sesam_connect(string catalog, string schema, string user);</insert>

23359

<dialog title="Insert sesam_connect">sesam_connect(%0, %1, %2);</dialog>

23360

23361

</function>

23362

23363

23364

Return status information for last SESAM call

23365

</description>

23366

<return type="array">array</return>

23367

<insert>sesam_diagnostic();</insert>

23368

<dialog title="Insert sesam_diagnostic">sesam_diagnostic();</dialog>

23369

23370

</function>

23371

23372

<description>Detach from SESAM connection</description>

23373

23374

<insert>sesam_disconnect();</insert>

23375

<dialog title="Insert sesam_disconnect">sesam_disconnect();</dialog>

23376

23377

</function>

23378

23379

<description>Returns error message of last SESAM call</description>

23380

<return type="string">string</return>

23381

<insert>sesam_errormsg();</insert>

23382

<dialog title="Insert sesam_errormsg">sesam_errormsg();</dialog>

23383

23384

</function>

23385

23386

<description>Execute an "immediate" SQL-statement</description>

23387

<param name="query" required="1" vallist="0" default="" type="string">query</param>

23388

<return type="string">string</return>

23389

<insert>sesam_execimm(string query);</insert>

23390

<dialog title="Insert sesam_execimm">sesam_execimm(%0);</dialog>

23391

23392

</function>

23393

23394

<description>Fetch one row as an associative array</description>

23395

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23396

<param name="whence" required="0" vallist="0" default="" type="int">whence</param>

23397

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

23398

<return type="array">array</return>

23399

<insert>sesam_fetch_array(string result_id [,int whence] [,int offset]);</insert>

23400

<dialog title="Insert sesam_fetch_array">sesam_fetch_array(%0, %1, %2);</dialog>

23401

23402

</function>

23403

23404

<description>Return all or part of a query result</description>

23405

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23406

23407

<return type="mixed">mixed</return>

23408

<insert>sesam_fetch_result(string result_id [,int max_rows]);</insert>

23409

<dialog title="Insert sesam_fetch_result">sesam_fetch_result(%0, %1);</dialog>

23410

23411

</function>

23412

23413

<description>Fetch one row as an array</description>

23414

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23415

<param name="whence" required="0" vallist="0" default="" type="int">whence</param>

23416

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

23417

<return type="array">array</return>

23418

<insert>sesam_fetch_row(string result_id [,int whence] [,int offset]);</insert>

23419

<dialog title="Insert sesam_fetch_row">sesam_fetch_row(%0, %1, %2);</dialog>

23420

23421

</function>

23422

23423

23424

Return meta information about individual columns in a result

23425

</description>

23426

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23427

<return type="array">array</return>

23428

<insert>sesam_field_array(string result_id);</insert>

23429

<dialog title="Insert sesam_field_array">sesam_field_array(%0);</dialog>

23430

23431

</function>

23432

23433

23434

Return one column name of the result set

23435

</description>

23436

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23437

<param name="index" required="1" vallist="0" default="" type="int">index</param>

23438

23439

<insert>sesam_field_name(string result_id, int index);</insert>

23440

<dialog title="Insert sesam_field_name">sesam_field_name(%0, %1);</dialog>

23441

23442

</function>

23443

23444

<description>Releases resources for the query</description>

23445

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23446

23447

<insert>sesam_free_result(string result_id);</insert>

23448

<dialog title="Insert sesam_free_result">sesam_free_result(%0);</dialog>

23449

23450

</function>

23451

23452

23453

Return the number of fields/columns in a result set

23454

</description>

23455

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23456

23457

<insert>sesam_num_fields(string result_id);</insert>

23458

<dialog title="Insert sesam_num_fields">sesam_num_fields(%0);</dialog>

23459

23460

</function>

23461

23462

<description>Perform a SESAM SQL query and prepare the result</description>

23463

<param name="query" required="1" vallist="0" default="" type="string">query</param>

23464

<param name="scrollable" required="0" vallist="0" default="" type="bool">scrollable</param>

23465

<return type="string">string</return>

23466

<insert>sesam_query(string query [,bool scrollable]);</insert>

23467

<dialog title="Insert sesam_query">sesam_query(%0, %1);</dialog>

23468

23469

</function>

23470

23471

23472

Discard any pending updates to the SESAM database

23473

</description>

23474

23475

<insert>sesam_rollback();</insert>

23476

<dialog title="Insert sesam_rollback">sesam_rollback();</dialog>

23477

23478

</function>

23479

23480

23481

Set scrollable cursor mode for subsequent fetches

23482

</description>

23483

<param name="result_id" required="1" vallist="0" default="" type="string">result_id</param>

23484

<param name="whence" required="1" vallist="0" default="" type="int">whence</param>

23485

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

23486

23487

<insert>sesam_seek_row(string result_id, int whence [,int offset]);</insert>

23488

<dialog title="Insert sesam_seek_row">sesam_seek_row(%0, %1, %2);</dialog>

23489

23490

</function>

23491

23492

<description>Set SESAM transaction parameters</description>

23493

<param name="isolation_level" required="1" vallist="0" default="" type="int">isolation_level</param>

23494

23495

23496

<insert>sesam_settransaction(int isolation_level, int read_only);</insert>

23497

<dialog title="Insert sesam_settransaction">sesam_settransaction(%0, %1);</dialog>

23498

23499

</function>

23500

</group>

23501

23502

23503

<description>Return current cache expire</description>

23504

<param name="new_cache_expire" required="0" vallist="0" default="" type="int">new_cache_expire</param>

23505

23506

<insert>session_cache_expire([int new_cache_expire]);</insert>

23507

<dialog title="Insert session_cache_expire">session_cache_expire(%0);</dialog>

23508

23509

</function>

23510

23511

<description>Get and/or set the current cache limiter</description>

23512

<param name="cache_limiter" required="0" vallist="0" default="" type="string">cache_limiter</param>

23513

<return type="string">string</return>

23514

<insert>session_cache_limiter([string cache_limiter]);</insert>

23515

<dialog title="Insert session_cache_limiter">session_cache_limiter(%0);</dialog>

23516

23517

</function>

23518

23519

<description>Decodes session data from a string</description>

23520

23521

23522

<insert>session_decode(string data);</insert>

23523

<dialog title="Insert session_decode">session_decode(%0);</dialog>

23524

23525

</function>

23526

23527

<description>Destroys all data registered to a session</description>

23528

23529

<insert>session_destroy();</insert>

23530

<dialog title="Insert session_destroy">session_destroy();</dialog>

23531

23532

</function>

23533

23534

23535

Encodes the current session data as a string

23536

</description>

23537

<return type="string">string</return>

23538

<insert>session_encode();</insert>

23539

<dialog title="Insert session_encode">session_encode();</dialog>

23540

23541

</function>

23542

23543

23544

Get the session cookie parameters

23545

</description>

23546

<return type="array">array</return>

23547

<insert>session_get_cookie_params();</insert>

23548

<dialog title="Insert session_get_cookie_params">session_get_cookie_params();</dialog>

23549

23550

</function>

23551

23552

<description>Get and/or set the current session id</description>

23553

23554

<return type="string">string</return>

23555

<insert>session_id([string id]);</insert>

23556

<dialog title="Insert session_id">session_id(%0);</dialog>

23557

23558

</function>

23559

23560

23561

Find out whether a global variable is registered in a session

23562

</description>

23563

23564

23565

<insert>session_is_registered(string name);</insert>

23566

<dialog title="Insert session_is_registered">session_is_registered(%0);</dialog>

23567

23568

</function>

23569

23570

<description>Get and/or set the current session module</description>

23571

<param name="module" required="0" vallist="0" default="" type="string">module</param>

23572

<return type="string">string</return>

23573

<insert>session_module_name([string module]);</insert>

23574

<dialog title="Insert session_module_name">session_module_name(%0);</dialog>

23575

23576

</function>

23577

23578

<description>Get and/or set the current session name</description>

23579

23580

<return type="string">string</return>

23581

<insert>session_name([string name]);</insert>

23582

<dialog title="Insert session_name">session_name(%0);</dialog>

23583

23584

</function>

23585

23586

<description>Begin session - reinitializes frozen variables, but no writeback on request end</description>

23587

23588

<insert>session_readonly();</insert>

23589

<dialog title="Insert session_readonly">session_readonly();</dialog>

23590

23591

</function>

23592

23593

23594

Register one or more global variables with the current session

23595

</description>

23596

23597

23598

23599

<insert>session_register(mixed name [,mixed ...]);</insert>

23600

<dialog title="Insert session_register">session_register(%0, %1);</dialog>

23601

23602

</function>

23603

23604

<description>Get and/or set the current session save path</description>

23605

23606

<return type="string">string</return>

23607

<insert>session_save_path([string path]);</insert>

23608

<dialog title="Insert session_save_path">session_save_path(%0);</dialog>

23609

23610

</function>

23611

23612

23613

Set the session cookie parameters

23614

</description>

23615

<param name="lifetime" required="1" vallist="0" default="" type="int">lifetime</param>

23616

23617

<param name="domain" required="0" vallist="0" default="" type="string">domain</param>

23618

<param name="secure" required="0" vallist="0" default="" type="bool">secure</param>

23619

23620

<insert>session_set_cookie_params(int lifetime [,string path] [,string domain] [,bool secure]);</insert>

23621

<dialog title="Insert session_set_cookie_params">session_set_cookie_params(%0, %1, %2, %3);</dialog>

23622

23623

</function>

23624

23625

23626

Sets user-level session storage functions

23627

</description>

23628

23629

<param name="close" required="1" vallist="0" default="" type="string">close</param>

23630

23631

<param name="write" required="1" vallist="0" default="" type="string">write</param>

23632

<param name="destroy" required="1" vallist="0" default="" type="string">destroy</param>

23633

23634

23635

<insert>session_set_save_handler(string open, string close, string read, string write, string destroy, string gc);</insert>

23636

<dialog title="Insert session_set_save_handler">session_set_save_handler(%0, %1, %2, %3, %4, %5);</dialog>

23637

23638

</function>

23639

23640

<description>Initialize session data</description>

23641

23642

<insert>session_start();</insert>

23643

<dialog title="Insert session_start">session_start();</dialog>

23644

23645

</function>

23646

23647

23648

Unregister a global variable from the current session

23649

</description>

23650

23651

23652

<insert>session_unregister(string name);</insert>

23653

<dialog title="Insert session_unregister">session_unregister(%0);</dialog>

23654

23655

</function>

23656

23657

23658

Free all session variables

23659

</description>

23660

23661

<insert>session_unset();</insert>

23662

<dialog title="Insert session_unset">session_unset();</dialog>

23663

23664

</function>

23665

23666

<description>Write session data and end session</description>

23667

23668

<insert>session_write_close();</insert>

23669

<dialog title="Insert session_write_close">session_write_close();</dialog>

23670

23671

</function>

23672

</group>

23673

23674

23675

<description>Close shared memory block</description>

23676

<param name="shmid" required="1" vallist="0" default="" type="int">shmid</param>

23677

23678

<insert>shmop_close(int shmid);</insert>

23679

<dialog title="Insert shmop_close">shmop_close(%0);</dialog>

23680

23681

</function>

23682

23683

<description>Delete shared memory block</description>

23684

<param name="shmid" required="1" vallist="0" default="" type="int">shmid</param>

23685

23686

<insert>shmop_delete(int shmid);</insert>

23687

<dialog title="Insert shmop_delete">shmop_delete(%0);</dialog>

23688

23689

</function>

23690

23691

<description>Create or open shared memory block</description>

23692

23693

<param name="flags" required="1" vallist="0" default="" type="string">flags</param>

23694

23695

23696

23697

<insert>shmop_open(int key, string flags, int mode, int size);</insert>

23698

<dialog title="Insert shmop_open">shmop_open(%0, %1, %2, %3);</dialog>

23699

23700

</function>

23701

23702

<description>Read data from shared memory block</description>

23703

<param name="shmid" required="1" vallist="0" default="" type="int">shmid</param>

23704

<param name="start" required="1" vallist="0" default="" type="int">start</param>

23705

<param name="count" required="1" vallist="0" default="" type="int">count</param>

23706

<return type="string">string</return>

23707

<insert>shmop_read(int shmid, int start, int count);</insert>

23708

<dialog title="Insert shmop_read">shmop_read(%0, %1, %2);</dialog>

23709

23710

</function>

23711

23712

<description>Get size of shared memory block</description>

23713

<param name="shmid" required="1" vallist="0" default="" type="int">shmid</param>

23714

23715

<insert>shmop_size(int shmid);</insert>

23716

<dialog title="Insert shmop_size">shmop_size(%0);</dialog>

23717

23718

</function>

23719

23720

<description>Write data into shared memory block</description>

23721

<param name="shmid" required="1" vallist="0" default="" type="int">shmid</param>

23722

23723

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

23724

23725

<insert>shmop_write(int shmid, string data, int offset);</insert>

23726

<dialog title="Insert shmop_write">shmop_write(%0, %1, %2);</dialog>

23727

23728

</function>

23729

</group>

23730

23731

23732

<description>Fetch the current value of the UCD library's quick_print setting

23733

</description>

23734

23735

<insert>snmp_get_quick_print();</insert>

23736

<dialog title="Insert snmp_get_quick_print">snmp_get_quick_print();</dialog>

23737

23738

</function>

23739

23740

<description>Set the value of quick_print within the UCD SNMP library

23741

</description>

23742

<param name="quick_print" required="1" vallist="0" default="" type="bool">quick_print</param>

23743

23744

<insert>snmp_set_quick_print(bool quick_print);</insert>

23745

<dialog title="Insert snmp_set_quick_print">snmp_set_quick_print(%0);</dialog>

23746

23747

</function>

23748

23749

<description>Fetch an SNMP object</description>

23750

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

23751

<param name="community" required="1" vallist="0" default="" type="string">community</param>

23752

<param name="object_id" required="1" vallist="0" default="" type="string">object_id</param>

23753

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

23754

<param name="retries" required="0" vallist="0" default="" type="int">retries</param>

23755

<return type="string">string</return>

23756

<insert>snmpget(string hostname, string community, string object_id [,int timeout] [,int retries]);</insert>

23757

<dialog title="Insert snmpget">snmpget(%0, %1, %2, %3, %4);</dialog>

23758

23759

</function>

23760

23761

23762

Return all objects including their respective object ID within the specified one

23763

</description>

23764

23765

<param name="community" required="1" vallist="0" default="" type="string">community</param>

23766

<param name="object_id" required="1" vallist="0" default="" type="string">object_id</param>

23767

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

23768

<param name="retries" required="0" vallist="0" default="" type="int">retries</param>

23769

<return type="array">array</return>

23770

<insert>snmprealwalk(string host, string community, string object_id [,int timeout] [,int retries]);</insert>

23771

<dialog title="Insert snmprealwalk">snmprealwalk(%0, %1, %2, %3, %4);</dialog>

23772

23773

</function>

23774

23775

<description>Set an SNMP object</description>

23776

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

23777

<param name="community" required="1" vallist="0" default="" type="string">community</param>

23778

<param name="object_id" required="1" vallist="0" default="" type="string">object_id</param>

23779

23780

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

23781

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

23782

<param name="retries" required="0" vallist="0" default="" type="int">retries</param>

23783

23784

<insert>snmpset(string hostname, string community, string object_id, string type, mixed value [,int timeout] [,int retries]);</insert>

23785

<dialog title="Insert snmpset">snmpset(%0, %1, %2, %3, %4, %5, %6);</dialog>

23786

23787

</function>

23788

23789

<description>Fetch all the SNMP objects from an agent</description>

23790

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

23791

<param name="community" required="1" vallist="0" default="" type="string">community</param>

23792

<param name="object_id" required="1" vallist="0" default="" type="string">object_id</param>

23793

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

23794

<param name="retries" required="0" vallist="0" default="" type="int">retries</param>

23795

<return type="array">array</return>

23796

<insert>snmpwalk(string hostname, string community, string object_id [,int timeout] [,int retries]);</insert>

23797

<dialog title="Insert snmpwalk">snmpwalk(%0, %1, %2, %3, %4);</dialog>

23798

23799

</function>

23800

23801

<description>Query for a tree of information about a network entity

23802

</description>

23803

<param name="hostname" required="1" vallist="0" default="" type="string">hostname</param>

23804

<param name="community" required="1" vallist="0" default="" type="string">community</param>

23805

<param name="object_id" required="1" vallist="0" default="" type="string">object_id</param>

23806

<param name="timeout" required="0" vallist="0" default="" type="int">timeout</param>

23807

<param name="retries" required="0" vallist="0" default="" type="int">retries</param>

23808

<return type="array">array</return>

23809

<insert>snmpwalkoid(string hostname, string community, string object_id [,int timeout] [,int retries]);</insert>

23810

<dialog title="Insert snmpwalkoid">snmpwalkoid(%0, %1, %2, %3, %4);</dialog>

23811

23812

</function>

23813

</group>

23814

23815

23816

<description>Accepts a connection on a socket</description>

23817

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23818

<return type="resource">resource</return>

23819

<insert>socket_accept(resource socket);</insert>

23820

<dialog title="Insert socket_accept">socket_accept(%0);</dialog>

23821

23822

</function>

23823

23824

<description>Binds a name to a socket</description>

23825

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23826

<param name="address" required="1" vallist="0" default="" type="string">address</param>

23827

23828

23829

<insert>socket_bind(resource socket, string address [,int port]);</insert>

23830

<dialog title="Insert socket_bind">socket_bind(%0, %1, %2);</dialog>

23831

23832

</function>

23833

23834

<description>Clears the error on the socket or the last error code</description>

23835

<param name="socket" required="0" vallist="0" default="" type="resource">socket</param>

23836

23837

<insert>socket_clear_error([resource socket]);</insert>

23838

<dialog title="Insert socket_clear_error">socket_clear_error(%0);</dialog>

23839

23840

</function>

23841

23842

<description>Closes a socket resource</description>

23843

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23844

23845

<insert>socket_close(resource socket);</insert>

23846

<dialog title="Insert socket_close">socket_close(%0);</dialog>

23847

23848

</function>

23849

23850

<description>Initiates a connection on a socket</description>

23851

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23852

<param name="address" required="1" vallist="0" default="" type="string">address</param>

23853

23854

23855

<insert>socket_connect(resource socket, string address [,int port]);</insert>

23856

<dialog title="Insert socket_connect">socket_connect(%0, %1, %2);</dialog>

23857

23858

</function>

23859

23860

<description>Opens a socket on port to accept connections </description>

23861

23862

<param name="backlog" required="0" vallist="0" default="" type="int">backlog</param>

23863

<return type="resource">resource</return>

23864

<insert>socket_create_listen(int port [,int backlog]);</insert>

23865

<dialog title="Insert socket_create_listen">socket_create_listen(%0, %1);</dialog>

23866

23867

</function>

23868

23869

<description>Creates a pair of indistinguishable sockets and stores them in fds. </description>

23870

<param name="domain" required="1" vallist="0" default="" type="int">domain</param>

23871

23872

<param name="protocol" required="1" vallist="0" default="" type="int">protocol</param>

23873

23874

23875

<insert>socket_create_pair(int domain, int type, int protocol, array &fd);</insert>

23876

<dialog title="Insert socket_create_pair">socket_create_pair(%0, %1, %2, %3);</dialog>

23877

23878

</function>

23879

23880

<description>Create a socket (endpoint for communication)</description>

23881

<param name="domain" required="1" vallist="0" default="" type="int">domain</param>

23882

23883

<param name="protocol" required="1" vallist="0" default="" type="int">protocol</param>

23884

<return type="resource">resource</return>

23885

<insert>socket_create(int domain, int type, int protocol);</insert>

23886

<dialog title="Insert socket_create">socket_create(%0, %1, %2);</dialog>

23887

23888

</function>

23889

23890

<description>Gets socket options for the socket </description>

23891

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23892

<param name="level" required="1" vallist="0" default="" type="int">level</param>

23893

<param name="optname" required="1" vallist="0" default="" type="int">optname</param>

23894

<return type="mixed">mixed</return>

23895

<insert>socket_get_option(resource socket, int level, int optname);</insert>

23896

<dialog title="Insert socket_get_option">socket_get_option(%0, %1, %2);</dialog>

23897

23898

</function>

23899

23900

23901

Queries the remote side of the given socket which may either result in host/port

23902

or in a UNIX filesystem path, dependent on its type.

23903

</description>

23904

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23905

23906

23907

23908

<insert>socket_getpeername(resource socket, string &addr [,int &port]);</insert>

23909

<dialog title="Insert socket_getpeername">socket_getpeername(%0, %1, %2);</dialog>

23910

23911

</function>

23912

23913

23914

Queries the local side of the given socket which may either result in host/port

23915

or in a UNIX filesystem path, dependent on its type.

23916

</description>

23917

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23918

23919

23920

23921

<insert>socket_getsockname(resource socket, string &addr [,int &port]);</insert>

23922

<dialog title="Insert socket_getsockname">socket_getsockname(%0, %1, %2);</dialog>

23923

23924

</function>

23925

23926

<description>Adds a new vector to the scatter/gather array </description>

23927

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

23928

23929

23930

<insert>socket_iovec_add(resource iovec, int iov_len);</insert>

23931

<dialog title="Insert socket_iovec_add">socket_iovec_add(%0, %1);</dialog>

23932

23933

</function>

23934

23935

<description>...]) Builds a 'struct iovec' for use with sendmsg, recvmsg, writev, and readv </description>

23936

<param name="num_vectors" required="1" vallist="0" default="" type="int">num_vectors</param>

23937

<return type="resource">resource</return>

23938

<insert>socket_iovec_alloc(int num_vectors);</insert>

23939

<dialog title="Insert socket_iovec_alloc">socket_iovec_alloc(%0);</dialog>

23940

23941

</function>

23942

23943

<description>Deletes a vector from an array of vectors </description>

23944

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

23945

23946

23947

<insert>socket_iovec_delete(resource iovec, int iov_pos);</insert>

23948

<dialog title="Insert socket_iovec_delete">socket_iovec_delete(%0, %1);</dialog>

23949

23950

</function>

23951

23952

<description>Returns the data held in the iovec specified by iovec_id[iovec_position] </description>

23953

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

23954

<param name="iovec_position" required="1" vallist="0" default="" type="int">iovec_position</param>

23955

<return type="string">string</return>

23956

<insert>socket_iovec_fetch(resource iovec, int iovec_position);</insert>

23957

<dialog title="Insert socket_iovec_fetch">socket_iovec_fetch(%0, %1);</dialog>

23958

23959

</function>

23960

23961

<description>Frees the iovec specified by iovec_id </description>

23962

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

23963

23964

<insert>socket_iovec_free(resource iovec);</insert>

23965

<dialog title="Insert socket_iovec_free">socket_iovec_free(%0);</dialog>

23966

23967

</function>

23968

23969

<description>Sets the data held in iovec_id[iovec_position] to new_val </description>

23970

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

23971

<param name="iovec_position" required="1" vallist="0" default="" type="int">iovec_position</param>

23972

23973

23974

<insert>socket_iovec_set(resource iovec, int iovec_position, string new_val);</insert>

23975

<dialog title="Insert socket_iovec_set">socket_iovec_set(%0, %1, %2);</dialog>

23976

23977

</function>

23978

23979

<description>Returns the last error on the socket </description>

23980

<param name="socket" required="0" vallist="0" default="" type="resource">socket</param>

23981

23982

<insert>socket_last_error([resource socket]);</insert>

23983

<dialog title="Insert socket_last_error">socket_last_error(%0);</dialog>

23984

23985

</function>

23986

23987

<description>Listens for a connection on a socket</description>

23988

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23989

<param name="backlog" required="0" vallist="0" default="" type="int">backlog</param>

23990

23991

<insert>socket_listen(resource socket [,int backlog]);</insert>

23992

<dialog title="Insert socket_listen">socket_listen(%0, %1);</dialog>

23993

23994

</function>

23995

23996

<description>Reads a maximum of length bytes from a socket</description>

23997

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

23998

<param name="length" required="1" vallist="0" default="" type="int">length</param>

23999

24000

<return type="string">string</return>

24001

<insert>socket_read(resource socket, int length [,int type]);</insert>

24002

<dialog title="Insert socket_read">socket_read(%0, %1, %2);</dialog>

24003

24004

</function>

24005

24006

<description>Reads from an fd, using the scatter-gather array defined by iovec_id </description>

24007

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24008

<param name="iovec_id" required="1" vallist="0" default="" type="resource">iovec_id</param>

24009

24010

<insert>socket_readv(resource socket, resource iovec_id);</insert>

24011

<dialog title="Insert socket_readv">socket_readv(%0, %1);</dialog>

24012

24013

</function>

24014

24015

<description>Receives data from a connected socket </description>

24016

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24017

24018

24019

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

24020

24021

<insert>socket_recv(resource socket, string &buf, int len, int flags);</insert>

24022

<dialog title="Insert socket_recv">socket_recv(%0, %1, %2, %3);</dialog>

24023

24024

</function>

24025

24026

<description>Receives data from a socket, connected or not </description>

24027

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24028

24029

24030

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

24031

24032

24033

24034

<insert>socket_recvfrom(resource socket, string &buf, int len, int flags, string &name [,int &port]);</insert>

24035

<dialog title="Insert socket_recvfrom">socket_recvfrom(%0, %1, %2, %3, %4, %5);</dialog>

24036

24037

</function>

24038

24039

<description>Used to receive messages on a socket, whether connection-oriented or not </description>

24040

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24041

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

24042

<param name="&control" required="1" vallist="0" default="" type="array">&control</param>

24043

<param name="&controllen" required="1" vallist="0" default="" type="int">&controllen</param>

24044

<param name="&flags" required="1" vallist="0" default="" type="int">&flags</param>

24045

24046

24047

24048

<insert>socket_recvmsg(resource socket, resource iovec, array &control, int &controllen, int &flags, string &addr [,int &port]);</insert>

24049

<dialog title="Insert socket_recvmsg">socket_recvmsg(%0, %1, %2, %3, %4, %5, %6);</dialog>

24050

24051

</function>

24052

24053

<description>Runs the select() system call on the given arrays of sockets with a timeout specified by tv_sec and tv_usec </description>

24054

24055

<param name="&write" required="1" vallist="0" default="" type="resource">&write</param>

24056

<param name="&except" required="1" vallist="0" default="" type="resource">&except</param>

24057

24058

24059

24060

<insert>socket_select(resource &read, resource &write, resource &except, int tv_sec [,int tv_usec]);</insert>

24061

<dialog title="Insert socket_select">socket_select(%0, %1, %2, %3, %4);</dialog>

24062

24063

</function>

24064

24065

<description>Sends data to a connected socket </description>

24066

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24067

24068

24069

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

24070

24071

<insert>socket_send(resource socket, string buf, int len, int flags);</insert>

24072

<dialog title="Insert socket_send">socket_send(%0, %1, %2, %3);</dialog>

24073

24074

</function>

24075

24076

<description>Sends a message to a socket, regardless of whether it is connection-oriented or not </description>

24077

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24078

<param name="iovec" required="1" vallist="0" default="" type="resource">iovec</param>

24079

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

24080

24081

24082

24083

<insert>socket_sendmsg(resource socket, resource iovec, int flags, string addr [,int port]);</insert>

24084

<dialog title="Insert socket_sendmsg">socket_sendmsg(%0, %1, %2, %3, %4);</dialog>

24085

24086

</function>

24087

24088

<description>Sends a message to a socket, whether it is connected or not </description>

24089

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24090

24091

24092

<param name="flags" required="1" vallist="0" default="" type="int">flags</param>

24093

24094

24095

24096

<insert>socket_sendto(resource socket, string buf, int len, int flags, string addr [,int port]);</insert>

24097

<dialog title="Insert socket_sendto">socket_sendto(%0, %1, %2, %3, %4, %5);</dialog>

24098

24099

</function>

24100

24101

<description>Sets nonblocking mode for file descriptor fd </description>

24102

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24103

24104

<insert>socket_set_nonblock(resource socket);</insert>

24105

<dialog title="Insert socket_set_nonblock">socket_set_nonblock(%0);</dialog>

24106

24107

</function>

24108

24109

<description>Sets socket options for the socket</description>

24110

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24111

<param name="level" required="1" vallist="0" default="" type="int">level</param>

24112

<param name="optname" required="1" vallist="0" default="" type="int">optname</param>

24113

<param name="optval" required="1" vallist="0" default="" type="mixed">optval</param>

24114

24115

<insert>socket_set_option(resource socket, int level, int optname, mixed optval);</insert>

24116

<dialog title="Insert socket_set_option">socket_set_option(%0, %1, %2, %3);</dialog>

24117

24118

</function>

24119

24120

<description>Shuts down a socket for receiving, sending, or both. </description>

24121

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24122

24123

24124

<insert>socket_shutdown(resource socket [,int how]);</insert>

24125

<dialog title="Insert socket_shutdown">socket_shutdown(%0, %1);</dialog>

24126

24127

</function>

24128

24129

<description>Return a string describing a socket error</description>

24130

<param name="errno" required="1" vallist="0" default="" type="int">errno</param>

24131

<return type="string">string</return>

24132

<insert>socket_strerror(int errno);</insert>

24133

<dialog title="Insert socket_strerror">socket_strerror(%0);</dialog>

24134

24135

</function>

24136

24137

<description>Write to a socket</description>

24138

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24139

<param name="buffer" required="1" vallist="0" default="" type="string">buffer</param>

24140

<param name="length" required="0" vallist="0" default="" type="int">length</param>

24141

24142

<insert>socket_write(resource socket, string buffer [,int length]);</insert>

24143

<dialog title="Insert socket_write">socket_write(%0, %1, %2);</dialog>

24144

24145

</function>

24146

24147

<description>Writes to a file descriptor, fd, using the scatter-gather array defined by iovec_id </description>

24148

<param name="socket" required="1" vallist="0" default="" type="resource">socket</param>

24149

<param name="iovec_id" required="1" vallist="0" default="" type="resource">iovec_id</param>

24150

24151

<insert>socket_writev(resource socket, resource iovec_id);</insert>

24152

<dialog title="Insert socket_writev">socket_writev(%0, %1);</dialog>

24153

24154

</function>

24155

</group>

24156

24157

24158

<description>Create a streams context</description>

24159

<param name="params" required="1" vallist="0" default="" type="array">params</param>

24160

<return type="resource">resource</return>

24161

<insert>stream_context_create(array params);</insert>

24162

<dialog title="Insert stream_context_create">stream_context_create(%0);</dialog>

24163

24164

</function>

24165

24166

<description>Retrieve options for a stream/wrapper/context</description>

24167

<param name="stream|context" required="1" vallist="0" default="" type="resource">stream|context</param>

24168

24169

<insert>stream_context_get_options(resource stream|context);</insert>

24170

<dialog title="Insert stream_context_get_options">stream_context_get_options(%0);</dialog>

24171

24172

</function>

24173

24174

<description>Sets an option for a stream/wrapper/context</description>

24175

<param name="context|stream" required="1" vallist="0" default="" type="resource">context|stream</param>

24176

<param name="wrapper" required="1" vallist="0" default="" type="string">wrapper</param>

24177

<param name="option" required="1" vallist="0" default="" type="string">option</param>

24178

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

24179

24180

<insert>stream_context_set_option(resource context|stream, string wrapper, string option, mixed value);</insert>

24181

<dialog title="Insert stream_context_set_option">stream_context_set_option(%0, %1, %2, %3);</dialog>

24182

24183

</function>

24184

24185

<description>Set parameters for a stream/wrapper/context</description>

24186

<param name="stream|context" required="1" vallist="0" default="" type="resource">stream|context</param>

24187

<param name="params" required="1" vallist="0" default="" type="array">params</param>

24188

24189

<insert>stream_context_set_params(resource stream|context, array params);</insert>

24190

<dialog title="Insert stream_context_set_params">stream_context_set_params(%0, %1);</dialog>

24191

24192

</function>

24193

24194

<description>Attach a filter to a stream.</description>

24195

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24196

<param name="filtername" required="1" vallist="0" default="" type="string">filtername</param>

24197

<param name="read_write" required="0" vallist="0" default="" type="int">read_write</param>

24198

<param name="params" required="0" vallist="0" default="" type="string">params</param>

24199

24200

<insert>stream_filter_append(resource stream, string filtername [,int read_write] [,string params]);</insert>

24201

<dialog title="Insert stream_filter_append">stream_filter_append(%0, %1, %2, %3);</dialog>

24202

24203

</function>

24204

24205

<description>Attach a filter to a stream.</description>

24206

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24207

<param name="filtername" required="1" vallist="0" default="" type="string">filtername</param>

24208

<param name="read_write" required="0" vallist="0" default="" type="int">read_write</param>

24209

<param name="params" required="0" vallist="0" default="" type="string">params</param>

24210

24211

<insert>stream_filter_prepend(resource stream, string filtername [,int read_write] [,string params]);</insert>

24212

<dialog title="Insert stream_filter_prepend">stream_filter_prepend(%0, %1, %2, %3);</dialog>

24213

24214

</function>

24215

24216

<description>Retrieve list of registered filters</description>

24217

<return type="array">array</return>

24218

<insert>stream_get_filters();</insert>

24219

<dialog title="Insert stream_get_filters">stream_get_filters();</dialog>

24220

24221

</function>

24222

24223

<description>Retrieves header/meta data from streams/file pointers</description>

24224

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24225

<return type="array">array</return>

24226

<insert>stream_get_meta_data(resource stream);</insert>

24227

<dialog title="Insert stream_get_meta_data">stream_get_meta_data(%0);</dialog>

24228

24229

</function>

24230

24231

<description>Retrieve list of registered streams</description>

24232

<return type="array">array</return>

24233

<insert>stream_get_wrappers();</insert>

24234

<dialog title="Insert stream_get_wrappers">stream_get_wrappers();</dialog>

24235

24236

</function>

24237

24238

<description>Register a stream filter implemented as a PHP class derived from </description>

24239

<param name="filtername" required="1" vallist="0" default="" type="string">filtername</param>

24240

<param name="classname" required="1" vallist="0" default="" type="string">classname</param>

24241

24242

<insert>stream_register_filter(string filtername, string classname);</insert>

24243

<dialog title="Insert stream_register_filter">stream_register_filter(%0, %1);</dialog>

24244

24245

</function>

24246

24247

<description>Register a URL wrapper implemented as a PHP class</description>

24248

<param name="protocol" required="1" vallist="0" default="" type="string">protocol</param>

24249

<param name="classname" required="1" vallist="0" default="" type="string">classname</param>

24250

24251

<insert>stream_register_wrapper(string protocol, string classname);</insert>

24252

<dialog title="Insert stream_register_wrapper">stream_register_wrapper(%0, %1);</dialog>

24253

24254

</function>

24255

24256

<description>Runs the equivalent of the select() system call on the given

24257

arrays of streams with a timeout specified by tv_sec and tv_usec </description>

24258

24259

<param name="&write" required="1" vallist="0" default="" type="resource">&write</param>

24260

<param name="&except" required="1" vallist="0" default="" type="resource">&except</param>

24261

24262

24263

24264

<insert>stream_select(resource &read, resource &write, resource &except, int tv_sec [,int tv_usec]);</insert>

24265

<dialog title="Insert stream_select">stream_select(%0, %1, %2, %3, %4);</dialog>

24266

24267

</function>

24268

24269

<description>Set blocking/non-blocking mode on a stream</description>

24270

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24271

24272

24273

<insert>stream_set_blocking(resource stream, int mode);</insert>

24274

<dialog title="Insert stream_set_blocking">stream_set_blocking(%0, %1);</dialog>

24275

24276

</function>

24277

24278

<description>Set timeout period on a stream</description>

24279

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24280

<param name="seconds" required="1" vallist="0" default="" type="int">seconds</param>

24281

<param name="microseconds" required="1" vallist="0" default="" type="int">microseconds</param>

24282

24283

<insert>stream_set_timeout(resource stream, int seconds, int microseconds);</insert>

24284

<dialog title="Insert stream_set_timeout">stream_set_timeout(%0, %1, %2);</dialog>

24285

24286

</function>

24287

24288

<description>Sets file buffering on the given stream</description>

24289

<param name="stream" required="1" vallist="0" default="" type="resource">stream</param>

24290

<param name="buffer" required="1" vallist="0" default="" type="int">buffer</param>

24291

24292

<insert>stream_set_write_buffer(resource stream, int buffer);</insert>

24293

<dialog title="Insert stream_set_write_buffer">stream_set_write_buffer(%0, %1);</dialog>

24294

24295

</function>

24296

</group>

24297

24298

24299

<description>Quote string with slashes in a C style</description>

24300

24301

<param name="charlist" required="1" vallist="0" default="" type="string">charlist</param>

24302

<return type="string">string</return>

24303

<insert>addcslashes(string str, string charlist);</insert>

24304

<dialog title="Insert addcslashes">addcslashes(%0, %1);</dialog>

24305

24306

</function>

24307

24308

<description>Quote string with slashes</description>

24309

24310

<return type="string">string</return>

24311

<insert>addslashes(string str);</insert>

24312

<dialog title="Insert addslashes">addslashes(%0);</dialog>

24313

24314

</function>

24315

24316

24317

Convert binary data into hexadecimal representation

24318

</description>

24319

24320

<return type="string">string</return>

24321

<insert>bin2hex(string str);</insert>

24322

24323

24324

</function>

24325

24326

<description>Return a specific character</description>

24327

<param name="ascii" required="1" vallist="0" default="" type="int">ascii</param>

24328

<return type="string">string</return>

24329

<insert>chr(int ascii);</insert>

24330

24331

24332

</function>

24333

24334

<description>Split a string into smaller chunks</description>

24335

24336

<param name="chunklen" required="0" vallist="0" default="" type="int">chunklen</param>

24337

24338

<return type="string">string</return>

24339

<insert>chunk_split(string body [,int chunklen] [,string end]);</insert>

24340

<dialog title="Insert chunk_split">chunk_split(%0, %1, %2);</dialog>

24341

24342

</function>

24343

24344

24345

Convert from one Cyrillic character set to another

24346

</description>

24347

24348

24349

24350

<return type="string">string</return>

24351

<insert>convert_cyr_string(string str, string from, string to);</insert>

24352

<dialog title="Insert convert_cyr_string">convert_cyr_string(%0, %1, %2);</dialog>

24353

24354

</function>

24355

24356

24357

Return information about characters used in a string

24358

</description>

24359

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24360

24361

<return type="mixed">mixed</return>

24362

<insert>count_chars(string string [,int mode]);</insert>

24363

<dialog title="Insert count_chars">count_chars(%0, %1);</dialog>

24364

24365

</function>

24366

24367

<description>Calculates the crc32 polynomial of a string</description>

24368

24369

24370

<insert>crc32(string str);</insert>

24371

24372

24373

</function>

24374

24375

<description>One-way string encryption (hashing)</description>

24376

24377

24378

<return type="string">string</return>

24379

<insert>crypt(string str [,string salt]);</insert>

24380

<dialog title="Insert crypt">crypt(%0, %1);</dialog>

24381

24382

</function>

24383

24384

<description>Output one or more strings</description>

24385

24386

24387

24388

<insert>echo(string arg1 [,string argn...]);</insert>

24389

24390

24391

</function>

24392

24393

<description>Split a string by string</description>

24394

<param name="separator" required="1" vallist="0" default="" type="string">separator</param>

24395

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24396

<param name="limit" required="0" vallist="0" default="" type="int">limit</param>

24397

<return type="array">array</return>

24398

<insert>explode(string separator, string string [,int limit]);</insert>

24399

<dialog title="Insert explode">explode(%0, %1, %2);</dialog>

24400

24401

</function>

24402

24403

<description>Write a formatted string to a stream</description>

24404

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

24405

<param name="format" required="1" vallist="0" default="" type="string">format</param>

24406

24407

24408

<insert>fprintf(resource handle, string format [,mixed args]);</insert>

24409

<dialog title="Insert fprintf">fprintf(%0, %1, %2);</dialog>

24410

24411

</function>

24412

24413

24414

Returns the translation table used by

24415

</description>

24416

<param name="table" required="1" vallist="0" default="" type="int">table</param>

24417

<param name="quote_style" required="0" vallist="0" default="" type="int">quote_style</param>

24418

<return type="array">array</return>

24419

<insert>get_html_translation_table(int table [,int quote_style]);</insert>

24420

<dialog title="Insert get_html_translation_table">get_html_translation_table(%0, %1);</dialog>

24421

24422

</function>

24423

24424

24425

Convert logical Hebrew text to visual text

24426

</description>

24427

<param name="hebrew_text" required="1" vallist="0" default="" type="string">hebrew_text</param>

24428

<param name="max_chars_per_line" required="0" vallist="0" default="" type="int">max_chars_per_line</param>

24429

<return type="string">string</return>

24430

<insert>hebrev(string hebrew_text [,int max_chars_per_line]);</insert>

24431

<dialog title="Insert hebrev">hebrev(%0, %1);</dialog>

24432

24433

</function>

24434

24435

24436

Convert logical Hebrew text to visual text with newline conversion

24437

</description>

24438

<param name="hebrew_text" required="1" vallist="0" default="" type="string">hebrew_text</param>

24439

<param name="max_chars_per_line" required="0" vallist="0" default="" type="int">max_chars_per_line</param>

24440

<return type="string">string</return>

24441

<insert>hebrevc(string hebrew_text [,int max_chars_per_line]);</insert>

24442

<dialog title="Insert hebrevc">hebrevc(%0, %1);</dialog>

24443

24444

</function>

24445

24446

24447

Convert all HTML entities to their applicable characters

24448

</description>

24449

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24450

<param name="quote_style" required="0" vallist="0" default="" type="int">quote_style</param>

24451

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

24452

<return type="string">string</return>

24453

<insert>html_entity_decode(string string [,int quote_style] [,string charset]);</insert>

24454

<dialog title="Insert html_entity_decode">html_entity_decode(%0, %1, %2);</dialog>

24455

24456

</function>

24457

24458

24459

Convert all applicable characters to HTML entities

24460

</description>

24461

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24462

<param name="quote_style" required="0" vallist="0" default="" type="int">quote_style</param>

24463

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

24464

<return type="string">string</return>

24465

<insert>htmlentities(string string [,int quote_style] [,string charset]);</insert>

24466

<dialog title="Insert htmlentities">htmlentities(%0, %1, %2);</dialog>

24467

24468

</function>

24469

24470

24471

Convert special characters to HTML entities

24472

</description>

24473

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24474

<param name="quote_style" required="0" vallist="0" default="" type="int">quote_style</param>

24475

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

24476

<return type="string">string</return>

24477

<insert>htmlspecialchars(string string [,int quote_style] [,string charset]);</insert>

24478

<dialog title="Insert htmlspecialchars">htmlspecialchars(%0, %1, %2);</dialog>

24479

24480

</function>

24481

24482

<description>Join array elements with a string</description>

24483

24484

<param name="pieces" required="1" vallist="0" default="" type="array">pieces</param>

24485

<return type="string">string</return>

24486

<insert>implode(string glue, array pieces);</insert>

24487

<dialog title="Insert implode">implode(%0, %1);</dialog>

24488

24489

</function>

24490

24491

24492

Calculate Levenshtein distance between two strings

24493

</description>

24494

24495

24496

24497

<insert>levenshtein(string str1, string str2);</insert>

24498

<dialog title="Insert levenshtein">levenshtein(%0, %1);</dialog>

24499

24500

</function>

24501

24502

<description>Get numeric formatting information</description>

24503

<return type="array">array</return>

24504

<insert>localeconv();</insert>

24505

<dialog title="Insert localeconv">localeconv();</dialog>

24506

24507

</function>

24508

24509

24510

Strip whitespace from the beginning of a string

24511

</description>

24512

24513

<param name="charlist" required="0" vallist="0" default="" type="string">charlist</param>

24514

<return type="string">string</return>

24515

<insert>ltrim(string str [,string charlist]);</insert>

24516

<dialog title="Insert ltrim">ltrim(%0, %1);</dialog>

24517

24518

</function>

24519

24520

<description>Calculates the md5 hash of a given filename</description>

24521

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

24522

<param name="raw_output" required="0" vallist="0" default="" type="bool">raw_output</param>

24523

<return type="string">string</return>

24524

<insert>md5_file(string filename [,bool raw_output]);</insert>

24525

24526

24527

</function>

24528

24529

<description>Calculate the md5 hash of a string</description>

24530

24531

<param name="raw_output" required="0" vallist="0" default="" type="bool">raw_output</param>

24532

<return type="string">string</return>

24533

<insert>md5(string str [,bool raw_output]);</insert>

24534

24535

24536

</function>

24537

24538

<description>Calculate the metaphone key of a string</description>

24539

24540

<return type="string">string</return>

24541

<insert>metaphone(string str);</insert>

24542

<dialog title="Insert metaphone">metaphone(%0);</dialog>

24543

24544

</function>

24545

24546

<description>Formats a number as a currency string</description>

24547

<param name="format" required="1" vallist="0" default="" type="string">format</param>

24548

<param name="number" required="1" vallist="0" default="" type="float">number</param>

24549

<return type="string">string</return>

24550

<insert>money_format(string format, float number);</insert>

24551

<dialog title="Insert money_format">money_format(%0, %1);</dialog>

24552

24553

</function>

24554

24555

24556

Query language and locale information

24557

</description>

24558

24559

<return type="string">string</return>

24560

<insert>nl_langinfo(int item);</insert>

24561

<dialog title="Insert nl_langinfo">nl_langinfo(%0);</dialog>

24562

24563

</function>

24564

24565

24566

Inserts HTML line breaks before all newlines in a string

24567

</description>

24568

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24569

<return type="string">string</return>

24570

<insert>nl2br(string string);</insert>

24571

24572

24573

</function>

24574

24575

<description>Format a number with grouped thousands</description>

24576

<param name="number" required="1" vallist="0" default="" type="float">number</param>

24577

<param name="decimals" required="0" vallist="0" default="" type="int">decimals</param>

24578

<param name="dec_point" required="0" vallist="0" default="" type="string">dec_point</param>

24579

<param name="thousands_sep" required="0" vallist="0" default="" type="string">thousands_sep</param>

24580

<return type="string">string</return>

24581

<insert>number_format(float number [,int decimals] [,string dec_point] [,string thousands_sep]);</insert>

24582

<dialog title="Insert number_format">number_format(%0, %1, %2, %3);</dialog>

24583

24584

</function>

24585

24586

<description>Return ASCII value of character</description>

24587

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24588

24589

<insert>ord(string string);</insert>

24590

24591

24592

</function>

24593

24594

<description>Parses the string into variables</description>

24595

24596

<param name="arr

24597

" required="0" vallist="0" default="" type="array">arr

24598

</param>

24599

24600

<insert>parse_str(string str [,array arr

24601

]);</insert>

24602

<dialog title="Insert parse_str">parse_str(%0, %1);</dialog>

24603

24604

</function>

24605

24606

<description>Output a string</description>

24607

24608

24609

<insert>print(string arg);</insert>

24610

<dialog title="Insert print">print(%0);</dialog>

24611

24612

</function>

24613

24614

<description>Output a formatted string</description>

24615

<param name="format" required="1" vallist="0" default="" type="string">format</param>

24616

24617

24618

<insert>printf(string format [,mixed args]);</insert>

24619

<dialog title="Insert printf">printf(%0, %1);</dialog>

24620

24621

</function>

24622

24623

24624

Convert a quoted-printable string to an 8 bit string

24625

</description>

24626

24627

<return type="string">string</return>

24628

<insert>quoted_printable_decode(string str);</insert>

24629

<dialog title="Insert quoted_printable_decode">quoted_printable_decode(%0);</dialog>

24630

24631

</function>

24632

24633

<description>Quote meta characters</description>

24634

24635

<return type="string">string</return>

24636

<insert>quotemeta(string str);</insert>

24637

<dialog title="Insert quotemeta">quotemeta(%0);</dialog>

24638

24639

</function>

24640

24641

24642

Strip whitespace from the end of a string

24643

</description>

24644

24645

<param name="charlist" required="0" vallist="0" default="" type="string">charlist</param>

24646

<return type="string">string</return>

24647

<insert>rtrim(string str [,string charlist]);</insert>

24648

<dialog title="Insert rtrim">rtrim(%0, %1);</dialog>

24649

24650

</function>

24651

24652

<description>Set locale information</description>

24653

<param name="category" required="1" vallist="0" default="" type="mixed">category</param>

24654

<param name="locale" required="1" vallist="0" default="" type="string">locale</param>

24655

24656

<return type="string">string</return>

24657

<insert>setlocale(mixed category, string locale [,string ...]);</insert>

24658

<dialog title="Insert setlocale">setlocale(%0, %1, %2);</dialog>

24659

24660

</function>

24661

24662

<description>Calculate the sha1 hash of a file</description>

24663

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

24664

<param name="raw_output" required="0" vallist="0" default="" type="bool">raw_output</param>

24665

<return type="string">string</return>

24666

<insert>sha1_file(string filename [,bool raw_output]);</insert>

24667

24668

24669

</function>

24670

24671

<description>Calculate the sha1 hash of a string</description>

24672

24673

<param name="raw_output" required="0" vallist="0" default="" type="bool">raw_output</param>

24674

<return type="string">string</return>

24675

<insert>sha1(string str [,bool raw_output]);</insert>

24676

24677

24678

</function>

24679

24680

24681

Calculate the similarity between two strings

24682

</description>

24683

<param name="first" required="1" vallist="0" default="" type="string">first</param>

24684

<param name="second" required="1" vallist="0" default="" type="string">second</param>

24685

<param name="percent" required="0" vallist="0" default="" type="float">percent</param>

24686

24687

<insert>similar_text(string first, string second [,float percent]);</insert>

24688

<dialog title="Insert similar_text">similar_text(%0, %1, %2);</dialog>

24689

24690

</function>

24691

24692

<description>Calculate the soundex key of a string</description>

24693

24694

<return type="string">string</return>

24695

<insert>soundex(string str);</insert>

24696

<dialog title="Insert soundex">soundex(%0);</dialog>

24697

24698

</function>

24699

24700

<description>Return a formatted string</description>

24701

<param name="format" required="1" vallist="0" default="" type="string">format</param>

24702

24703

<return type="string">string</return>

24704

<insert>sprintf(string format [,mixed args]);</insert>

24705

<dialog title="Insert sprintf">sprintf(%0, %1);</dialog>

24706

24707

</function>

24708

24709

24710

Parses input from a string according to a format

24711

</description>

24712

24713

<param name="format" required="1" vallist="0" default="" type="string">format</param>

24714

24715

<return type="mixed">mixed</return>

24716

<insert>sscanf(string str, string format [,string var1]);</insert>

24717

<dialog title="Insert sscanf">sscanf(%0, %1, %2);</dialog>

24718

24719

</function>

24720

24721

24722

Case-insensitive version of </description>

24723

<param name="search" required="1" vallist="0" default="" type="mixed">search</param>

24724

<param name="replace" required="1" vallist="0" default="" type="mixed">replace</param>

24725

<param name="subject" required="1" vallist="0" default="" type="mixed">subject</param>

24726

<return type="mixed">mixed</return>

24727

<insert>str_ireplace(mixed search, mixed replace, mixed subject);</insert>

24728

<dialog title="Insert str_ireplace">str_ireplace(%0, %1, %2);</dialog>

24729

24730

</function>

24731

24732

24733

Pad a string to a certain length with another string

24734

</description>

24735

<param name="input" required="1" vallist="0" default="" type="string">input</param>

24736

<param name="pad_length" required="1" vallist="0" default="" type="int">pad_length</param>

24737

<param name="pad_string" required="0" vallist="0" default="" type="string">pad_string</param>

24738

24739

<return type="string">string</return>

24740

<insert>str_pad(string input, int pad_length [,string pad_string] [,int pad_type]);</insert>

24741

24742

24743

</function>

24744

24745

<description>Repeat a string</description>

24746

<param name="input" required="1" vallist="0" default="" type="string">input</param>

24747

<param name="multiplier" required="1" vallist="0" default="" type="int">multiplier</param>

24748

<return type="string">string</return>

24749

<insert>str_repeat(string input, int multiplier);</insert>

24750

<dialog title="Insert str_repeat">str_repeat(%0, %1);</dialog>

24751

24752

</function>

24753

24754

24755

Replace all occurrences of the search string with the replacement string

24756

</description>

24757

<param name="search" required="1" vallist="0" default="" type="mixed">search</param>

24758

<param name="replace" required="1" vallist="0" default="" type="mixed">replace</param>

24759

<param name="subject" required="1" vallist="0" default="" type="mixed">subject</param>

24760

<return type="mixed">mixed</return>

24761

<insert>str_replace(mixed search, mixed replace, mixed subject);</insert>

24762

<dialog title="Insert str_replace">str_replace(%0, %1, %2);</dialog>

24763

24764

</function>

24765

24766

<description>Perform the rot13 transform on a string</description>

24767

24768

<return type="string">string</return>

24769

<insert>str_rot13(string str);</insert>

24770

24771

24772

</function>

24773

24774

<description>Randomly shuffles a string</description>

24775

24776

<return type="string">string</return>

24777

<insert>str_shuffle(string str);</insert>

24778

<dialog title="Insert str_shuffle">str_shuffle(%0);</dialog>

24779

24780

</function>

24781

24782

24783

Return information about words used in a string

24784

</description>

24785

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24786

<param name="format" required="0" vallist="0" default="" type="int">format</param>

24787

<return type="mixed">mixed</return>

24788

<insert>str_word_count(string string [,int format]);</insert>

24789

<dialog title="Insert str_word_count">str_word_count(%0, %1);</dialog>

24790

24791

</function>

24792

24793

24794

Binary safe case-insensitive string comparison

24795

</description>

24796

24797

24798

24799

<insert>strcasecmp(string str1, string str2);</insert>

24800

<dialog title="Insert strcasecmp">strcasecmp(%0, %1);</dialog>

24801

24802

</function>

24803

24804

<description>Binary safe string comparison</description>

24805

24806

24807

24808

<insert>strcmp(string str1, string str2);</insert>

24809

<dialog title="Insert strcmp">strcmp(%0, %1);</dialog>

24810

24811

</function>

24812

24813

<description>Locale based string comparison</description>

24814

24815

24816

24817

<insert>strcoll(string str1, string str2);</insert>

24818

<dialog title="Insert strcoll">strcoll(%0, %1);</dialog>

24819

24820

</function>

24821

24822

24823

Find length of initial segment not matching mask

24824

</description>

24825

24826

24827

24828

<insert>strcspn(string str1, string str2);</insert>

24829

<dialog title="Insert strcspn">strcspn(%0, %1);</dialog>

24830

24831

</function>

24832

24833

<description>Strip HTML and PHP tags from a string</description>

24834

24835

<param name="allowable_tags" required="0" vallist="0" default="" type="string">allowable_tags</param>

24836

<return type="string">string</return>

24837

<insert>strip_tags(string str [,string allowable_tags]);</insert>

24838

<dialog title="Insert strip_tags">strip_tags(%0, %1);</dialog>

24839

24840

</function>

24841

24842

24843

Un-quote string quoted with </description>

24844

24845

<return type="string">string</return>

24846

<insert>stripcslashes(string str);</insert>

24847

<dialog title="Insert stripcslashes">stripcslashes(%0);</dialog>

24848

24849

</function>

24850

24851

24852

Find position of first occurrence of a case-insensitive string

24853

</description>

24854

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24855

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

24856

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

24857

24858

<insert>stripos(string haystack, string needle [,int offset]);</insert>

24859

<dialog title="Insert stripos">stripos(%0, %1, %2);</dialog>

24860

24861

</function>

24862

24863

24864

Un-quote string quoted with </description>

24865

24866

<return type="string">string</return>

24867

<insert>stripslashes(string str);</insert>

24868

<dialog title="Insert stripslashes">stripslashes(%0);</dialog>

24869

24870

</function>

24871

24872

24873

Case-insensitive </description>

24874

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24875

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

24876

<return type="string">string</return>

24877

<insert>stristr(string haystack, string needle);</insert>

24878

<dialog title="Insert stristr">stristr(%0, %1);</dialog>

24879

24880

</function>

24881

24882

<description>Get string length</description>

24883

24884

24885

<insert>strlen(string str);</insert>

24886

<dialog title="Insert strlen">strlen(%0);</dialog>

24887

24888

</function>

24889

24890

24891

Case insensitive string comparisons using a "natural order"

24892

algorithm

24893

</description>

24894

24895

24896

24897

<insert>strnatcasecmp(string str1, string str2);</insert>

24898

<dialog title="Insert strnatcasecmp">strnatcasecmp(%0, %1);</dialog>

24899

24900

</function>

24901

24902

24903

String comparisons using a "natural order" algorithm

24904

</description>

24905

24906

24907

24908

<insert>strnatcmp(string str1, string str2);</insert>

24909

<dialog title="Insert strnatcmp">strnatcmp(%0, %1);</dialog>

24910

24911

</function>

24912

24913

24914

Binary safe case-insensitive string comparison of the first n

24915

characters

24916

</description>

24917

24918

24919

24920

24921

<insert>strncasecmp(string str1, string str2, int len);</insert>

24922

<dialog title="Insert strncasecmp">strncasecmp(%0, %1, %2);</dialog>

24923

24924

</function>

24925

24926

24927

Binary safe string comparison of the first n characters

24928

</description>

24929

24930

24931

24932

24933

<insert>strncmp(string str1, string str2, int len);</insert>

24934

<dialog title="Insert strncmp">strncmp(%0, %1, %2);</dialog>

24935

24936

</function>

24937

24938

24939

Find position of first occurrence of a string

24940

</description>

24941

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24942

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

24943

<param name="offset" required="0" vallist="0" default="" type="int">offset</param>

24944

24945

<insert>strpos(string haystack, string needle [,int offset]);</insert>

24946

<dialog title="Insert strpos">strpos(%0, %1, %2);</dialog>

24947

24948

</function>

24949

24950

24951

Find the last occurrence of a character in a string

24952

</description>

24953

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24954

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

24955

<return type="string">string</return>

24956

<insert>strrchr(string haystack, string needle);</insert>

24957

<dialog title="Insert strrchr">strrchr(%0, %1);</dialog>

24958

24959

</function>

24960

24961

<description>Reverse a string</description>

24962

<param name="string" required="1" vallist="0" default="" type="string">string</param>

24963

<return type="string">string</return>

24964

<insert>strrev(string string);</insert>

24965

<dialog title="Insert strrev">strrev(%0);</dialog>

24966

24967

</function>

24968

24969

24970

Find position of last occurrence of a char in a string

24971

</description>

24972

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24973

<param name="needle" required="1" vallist="0" default="" type="char">needle</param>

24974

24975

<insert>strrpos(string haystack, char needle);</insert>

24976

<dialog title="Insert strrpos">strrpos(%0, %1);</dialog>

24977

24978

</function>

24979

24980

24981

Find length of initial segment matching mask

24982

</description>

24983

24984

24985

24986

<insert>strspn(string str1, string str2);</insert>

24987

<dialog title="Insert strspn">strspn(%0, %1);</dialog>

24988

24989

</function>

24990

24991

<description>Find first occurrence of a string</description>

24992

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

24993

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

24994

<return type="string">string</return>

24995

<insert>strstr(string haystack, string needle);</insert>

24996

<dialog title="Insert strstr">strstr(%0, %1);</dialog>

24997

24998

</function>

24999

25000

<description>Tokenize string</description>

25001

25002

25003

<return type="string">string</return>

25004

<insert>strtok(string arg1, string arg2);</insert>

25005

<dialog title="Insert strtok">strtok(%0, %1);</dialog>

25006

25007

</function>

25008

25009

<description>Make a string lowercase</description>

25010

25011

<return type="string">string</return>

25012

<insert>strtolower(string str);</insert>

25013

<dialog title="Insert strtolower">strtolower(%0);</dialog>

25014

25015

</function>

25016

25017

<description>Make a string uppercase</description>

25018

<param name="string" required="1" vallist="0" default="" type="string">string</param>

25019

<return type="string">string</return>

25020

<insert>strtoupper(string string);</insert>

25021

<dialog title="Insert strtoupper">strtoupper(%0);</dialog>

25022

25023

</function>

25024

25025

<description>Translate certain characters</description>

25026

25027

25028

25029

<return type="string">string</return>

25030

<insert>strtr(string str, string from, string to);</insert>

25031

<dialog title="Insert strtr">strtr(%0, %1, %2);</dialog>

25032

25033

</function>

25034

25035

<description>Count the number of substring occurrences</description>

25036

<param name="haystack" required="1" vallist="0" default="" type="string">haystack</param>

25037

<param name="needle" required="1" vallist="0" default="" type="string">needle</param>

25038

25039

<insert>substr_count(string haystack, string needle);</insert>

25040

<dialog title="Insert substr_count">substr_count(%0, %1);</dialog>

25041

25042

</function>

25043

25044

<description>Replace text within a portion of a string</description>

25045

<param name="string" required="1" vallist="0" default="" type="string">string</param>

25046

<param name="replacement" required="1" vallist="0" default="" type="string">replacement</param>

25047

<param name="start" required="1" vallist="0" default="" type="int">start</param>

25048

<param name="length" required="0" vallist="0" default="" type="int">length</param>

25049

<return type="string">string</return>

25050

<insert>substr_replace(string string, string replacement, int start [,int length]);</insert>

25051

<dialog title="Insert substr_replace">substr_replace(%0, %1, %2, %3);</dialog>

25052

25053

</function>

25054

25055

<description>Return part of a string</description>

25056

<param name="string" required="1" vallist="0" default="" type="string">string</param>

25057

<param name="start" required="1" vallist="0" default="" type="int">start</param>

25058

<param name="length" required="0" vallist="0" default="" type="int">length</param>

25059

<return type="string">string</return>

25060

<insert>substr(string string, int start [,int length]);</insert>

25061

<dialog title="Insert substr">substr(%0, %1, %2);</dialog>

25062

25063

</function>

25064

25065

25066

Strip whitespace from the beginning and end of a string

25067

</description>

25068

25069

<param name="charlist" required="0" vallist="0" default="" type="string">charlist</param>

25070

<return type="string">string</return>

25071

<insert>trim(string str [,string charlist]);</insert>

25072

25073

25074

</function>

25075

25076

<description>Make a string's first character uppercase</description>

25077

25078

<return type="string">string</return>

25079

<insert>ucfirst(string str);</insert>

25080

<dialog title="Insert ucfirst">ucfirst(%0);</dialog>

25081

25082

</function>

25083

25084

25085

Uppercase the first character of each word in a string

25086

</description>

25087

25088

<return type="string">string</return>

25089

<insert>ucwords(string str);</insert>

25090

<dialog title="Insert ucwords">ucwords(%0);</dialog>

25091

25092

</function>

25093

25094

<description>Output a formatted string</description>

25095

<param name="format" required="1" vallist="0" default="" type="string">format</param>

25096

25097

25098

<insert>vprintf(string format, array args);</insert>

25099

<dialog title="Insert vprintf">vprintf(%0, %1);</dialog>

25100

25101

</function>

25102

25103

<description>Return a formatted string</description>

25104

<param name="format" required="1" vallist="0" default="" type="string">format</param>

25105

25106

<return type="string">string</return>

25107

<insert>vsprintf(string format, array args);</insert>

25108

<dialog title="Insert vsprintf">vsprintf(%0, %1);</dialog>

25109

25110

</function>

25111

25112

25113

Wraps a string to a given number of characters using a string

25114

break character.

25115

</description>

25116

25117

<param name="width" required="0" vallist="0" default="" type="int">width</param>

25118

<param name="break" required="0" vallist="0" default="" type="string">break</param>

25119

25120

<return type="string">string</return>

25121

<insert>wordwrap(string str [,int width] [,string break] [,boolean cut]);</insert>

25122

<dialog title="Insert wordwrap">wordwrap(%0, %1, %2, %3);</dialog>

25123

25124

</function>

25125

</group>

25126

25127

25128

<description>Get a URL from a Shockwave Flash movie</description>

25129

25130

<param name="target" required="1" vallist="0" default="" type="string">target</param>

25131

25132

<insert>swf_actiongeturl(string url, string target);</insert>

25133

<dialog title="Insert swf_actiongeturl">swf_actiongeturl(%0, %1);</dialog>

25134

25135

</function>

25136

25137

<description>Play a frame and then stop</description>

25138

<param name="framenumber" required="1" vallist="0" default="" type="int">framenumber</param>

25139

25140

<insert>swf_actiongotoframe(int framenumber);</insert>

25141

<dialog title="Insert swf_actiongotoframe">swf_actiongotoframe(%0);</dialog>

25142

25143

</function>

25144

25145

25146

Display a frame with the specified label

25147

</description>

25148

<param name="label" required="1" vallist="0" default="" type="string">label</param>

25149

25150

<insert>swf_actiongotolabel(string label);</insert>

25151

<dialog title="Insert swf_actiongotolabel">swf_actiongotolabel(%0);</dialog>

25152

25153

</function>

25154

25155

<description>Go foward one frame</description>

25156

25157

<insert>swf_actionnextframe();</insert>

25158

<dialog title="Insert swf_actionnextframe">swf_actionnextframe();</dialog>

25159

25160

</function>

25161

25162

25163

Start playing the flash movie from the current frame

25164

</description>

25165

25166

<insert>swf_actionplay();</insert>

25167

<dialog title="Insert swf_actionplay">swf_actionplay();</dialog>

25168

25169

</function>

25170

25171

<description>Go backwards one frame</description>

25172

25173

<insert>swf_actionprevframe();</insert>

25174

<dialog title="Insert swf_actionprevframe">swf_actionprevframe();</dialog>

25175

25176

</function>

25177

25178

<description>Set the context for actions</description>

25179

<param name="target" required="1" vallist="0" default="" type="string">target</param>

25180

25181

<insert>swf_actionsettarget(string target);</insert>

25182

<dialog title="Insert swf_actionsettarget">swf_actionsettarget(%0);</dialog>

25183

25184

</function>

25185

25186

25187

Stop playing the flash movie at the current frame

25188

</description>

25189

25190

<insert>swf_actionstop();</insert>

25191

<dialog title="Insert swf_actionstop">swf_actionstop();</dialog>

25192

25193

</function>

25194

25195

25196

Toggle between low and high quality

25197

</description>

25198

25199

<insert>swf_actiontogglequality();</insert>

25200

<dialog title="Insert swf_actiontogglequality">swf_actiontogglequality();</dialog>

25201

25202

</function>

25203

25204

25205

Skip actions if a frame has not been loaded

25206

</description>

25207

<param name="framenumber" required="1" vallist="0" default="" type="int">framenumber</param>

25208

<param name="skipcount" required="1" vallist="0" default="" type="int">skipcount</param>

25209

25210

<insert>swf_actionwaitforframe(int framenumber, int skipcount);</insert>

25211

<dialog title="Insert swf_actionwaitforframe">swf_actionwaitforframe(%0, %1);</dialog>

25212

25213

</function>

25214

25215

25216

Controls location, appearance and active area of the current button

25217

</description>

25218

<param name="states" required="1" vallist="0" default="" type="int">states</param>

25219

<param name="shapeid" required="1" vallist="0" default="" type="int">shapeid</param>

25220

<param name="depth" required="1" vallist="0" default="" type="int">depth</param>

25221

25222

<insert>swf_addbuttonrecord(int states, int shapeid, int depth);</insert>

25223

<dialog title="Insert swf_addbuttonrecord">swf_addbuttonrecord(%0, %1, %2);</dialog>

25224

25225

</function>

25226

25227

25228

Set the global add color to the rgba value specified

25229

</description>

25230

25231

25232

25233

25234

25235

<insert>swf_addcolor(float r, float g, float b, float a);</insert>

25236

<dialog title="Insert swf_addcolor">swf_addcolor(%0, %1, %2, %3);</dialog>

25237

25238

</function>

25239

25240

<description>Close the current Shockwave Flash file</description>

25241

<param name="

25242

return_file

25243

" required="0" vallist="0" default="" type="int">

25244

return_file

25245

</param>

25246

25247

<insert>swf_closefile([int

25248

return_file

25249

]);</insert>

25250

<dialog title="Insert swf_closefile">swf_closefile(%0);</dialog>

25251

25252

</function>

25253

25254

<description>Define a bitmap</description>

25255

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25256

<param name="image_name" required="1" vallist="0" default="" type="string">image_name</param>

25257

25258

<insert>swf_definebitmap(int objid, string image_name);</insert>

25259

<dialog title="Insert swf_definebitmap">swf_definebitmap(%0, %1);</dialog>

25260

25261

</function>

25262

25263

25264

Defines a font

25265

</description>

25266

<param name="fontid" required="1" vallist="0" default="" type="int">fontid</param>

25267

<param name="fontname" required="1" vallist="0" default="" type="string">fontname</param>

25268

25269

<insert>swf_definefont(int fontid, string fontname);</insert>

25270

<dialog title="Insert swf_definefont">swf_definefont(%0, %1);</dialog>

25271

25272

</function>

25273

25274

<description>Define a line</description>

25275

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25276

25277

25278

25279

25280

<param name="width" required="1" vallist="0" default="" type="float">width</param>

25281

25282

<insert>swf_defineline(int objid, float x1, float y1, float x2, float y2, float width);</insert>

25283

<dialog title="Insert swf_defineline">swf_defineline(%0, %1, %2, %3, %4, %5);</dialog>

25284

25285

</function>

25286

25287

25288

Define a polygon

25289

</description>

25290

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25291

<param name="coords" required="1" vallist="0" default="" type="array">coords</param>

25292

<param name="npoints" required="1" vallist="0" default="" type="int">npoints</param>

25293

<param name="width" required="1" vallist="0" default="" type="float">width</param>

25294

25295

<insert>swf_definepoly(int objid, array coords, int npoints, float width);</insert>

25296

<dialog title="Insert swf_definepoly">swf_definepoly(%0, %1, %2, %3);</dialog>

25297

25298

</function>

25299

25300

<description>Define a rectangle</description>

25301

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25302

25303

25304

25305

25306

<param name="width" required="1" vallist="0" default="" type="float">width</param>

25307

25308

<insert>swf_definerect(int objid, float x1, float y1, float x2, float y2, float width);</insert>

25309

<dialog title="Insert swf_definerect">swf_definerect(%0, %1, %2, %3, %4, %5);</dialog>

25310

25311

</function>

25312

25313

<description>Define a text string</description>

25314

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25315

25316

<param name="docenter" required="1" vallist="0" default="" type="int">docenter</param>

25317

25318

<insert>swf_definetext(int objid, string str, int docenter);</insert>

25319

<dialog title="Insert swf_definetext">swf_definetext(%0, %1, %2);</dialog>

25320

25321

</function>

25322

25323

25324

End the definition of the current button

25325

</description>

25326

25327

<insert>swf_endbutton();</insert>

25328

<dialog title="Insert swf_endbutton">swf_endbutton();</dialog>

25329

25330

</function>

25331

25332

<description>End the current action</description>

25333

25334

<insert>swf_enddoaction();</insert>

25335

<dialog title="Insert swf_enddoaction">swf_enddoaction();</dialog>

25336

25337

</function>

25338

25339

25340

Completes the definition of the current shape

25341

</description>

25342

25343

<insert>swf_endshape();</insert>

25344

<dialog title="Insert swf_endshape">swf_endshape();</dialog>

25345

25346

</function>

25347

25348

<description>End the definition of a symbol</description>

25349

25350

<insert>swf_endsymbol();</insert>

25351

<dialog title="Insert swf_endsymbol">swf_endsymbol();</dialog>

25352

25353

</function>

25354

25355

<description>Change the font size</description>

25356

25357

25358

<insert>swf_fontsize(float size);</insert>

25359

<dialog title="Insert swf_fontsize">swf_fontsize(%0);</dialog>

25360

25361

</function>

25362

25363

<description>Set the font slant</description>

25364

<param name="slant" required="1" vallist="0" default="" type="float">slant</param>

25365

25366

<insert>swf_fontslant(float slant);</insert>

25367

<dialog title="Insert swf_fontslant">swf_fontslant(%0);</dialog>

25368

25369

</function>

25370

25371

<description>Set the current font tracking</description>

25372

<param name="tracking" required="1" vallist="0" default="" type="float">tracking</param>

25373

25374

<insert>swf_fonttracking(float tracking);</insert>

25375

<dialog title="Insert swf_fonttracking">swf_fonttracking(%0);</dialog>

25376

25377

</function>

25378

25379

<description>Get information about a bitmap</description>

25380

<param name="bitmapid" required="1" vallist="0" default="" type="int">bitmapid</param>

25381

<return type="array">array</return>

25382

<insert>swf_getbitmapinfo(int bitmapid);</insert>

25383

<dialog title="Insert swf_getbitmapinfo">swf_getbitmapinfo(%0);</dialog>

25384

25385

</function>

25386

25387

25388

The height in pixels of a capital A and a lowercase x

25389

</description>

25390

<return type="array">array</return>

25391

<insert>swf_getfontinfo();</insert>

25392

<dialog title="Insert swf_getfontinfo">swf_getfontinfo();</dialog>

25393

25394

</function>

25395

25396

<description>Get the frame number of the current frame</description>

25397

25398

<insert>swf_getframe();</insert>

25399

<dialog title="Insert swf_getframe">swf_getframe();</dialog>

25400

25401

</function>

25402

25403

<description>Label the current frame</description>

25404

25405

25406

<insert>swf_labelframe(string name);</insert>

25407

<dialog title="Insert swf_labelframe">swf_labelframe(%0);</dialog>

25408

25409

</function>

25410

25411

<description>Define a viewing transformation</description>

25412

25413

25414

25415

<param name="reference_x" required="1" vallist="0" default="" type="float">reference_x</param>

25416

<param name="reference_y" required="1" vallist="0" default="" type="float">reference_y</param>

25417

<param name="reference_z" required="1" vallist="0" default="" type="float">reference_z</param>

25418

<param name="twist" required="1" vallist="0" default="" type="float">twist</param>

25419

25420

<insert>swf_lookat(float view_x, float view_y, float view_z, float reference_x, float reference_y, float reference_z, float twist);</insert>

25421

<dialog title="Insert swf_lookat">swf_lookat(%0, %1, %2, %3, %4, %5, %6);</dialog>

25422

25423

</function>

25424

25425

<description>Modify an object</description>

25426

<param name="depth" required="1" vallist="0" default="" type="int">depth</param>

25427

25428

25429

<insert>swf_modifyobject(int depth, int how);</insert>

25430

<dialog title="Insert swf_modifyobject">swf_modifyobject(%0, %1);</dialog>

25431

25432

</function>

25433

25434

25435

Sets the global multiply color to the rgba value specified

25436

</description>

25437

25438

25439

25440

25441

25442

<insert>swf_mulcolor(float r, float g, float b, float a);</insert>

25443

<dialog title="Insert swf_mulcolor">swf_mulcolor(%0, %1, %2, %3);</dialog>

25444

25445

</function>

25446

25447

<description>Returns the next free object id</description>

25448

25449

<insert>swf_nextid();</insert>

25450

<dialog title="Insert swf_nextid">swf_nextid();</dialog>

25451

25452

</function>

25453

25454

25455

Describe a transition used to trigger an action list

25456

</description>

25457

<param name="transition" required="1" vallist="0" default="" type="int">transition</param>

25458

25459

<insert>swf_oncondition(int transition);</insert>

25460

<dialog title="Insert swf_oncondition">swf_oncondition(%0);</dialog>

25461

25462

</function>

25463

25464

<description>Open a new Shockwave Flash file</description>

25465

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

25466

<param name="width" required="1" vallist="0" default="" type="float">width</param>

25467

<param name="height" required="1" vallist="0" default="" type="float">height</param>

25468

<param name="framerate" required="1" vallist="0" default="" type="float">framerate</param>

25469

25470

25471

25472

25473

<insert>swf_openfile(string filename, float width, float height, float framerate, float r, float g, float b);</insert>

25474

<dialog title="Insert swf_openfile">swf_openfile(%0, %1, %2, %3, %4, %5, %6);</dialog>

25475

25476

</function>

25477

25478

25479

Defines an orthographic mapping of user coordinates onto the

25480

current viewport

25481

</description>

25482

25483

25484

25485

25486

25487

25488

25489

<insert>swf_ortho(float xmin, float xmax, float ymin, float ymax, float zmin, float zmax);</insert>

25490

<dialog title="Insert swf_ortho">swf_ortho(%0, %1, %2, %3, %4, %5);</dialog>

25491

25492

</function>

25493

25494

25495

Defines 2D orthographic mapping of user coordinates onto the

25496

current viewport

25497

</description>

25498

25499

25500

25501

25502

25503

<insert>swf_ortho2(float xmin, float xmax, float ymin, float ymax);</insert>

25504

<dialog title="Insert swf_ortho2">swf_ortho2(%0, %1, %2, %3);</dialog>

25505

25506

</function>

25507

25508

25509

Define a perspective projection transformation

25510

</description>

25511

25512

<param name="aspect" required="1" vallist="0" default="" type="float">aspect</param>

25513

25514

25515

25516

<insert>swf_perspective(float fovy, float aspect, float near, float far);</insert>

25517

<dialog title="Insert swf_perspective">swf_perspective(%0, %1, %2, %3);</dialog>

25518

25519

</function>

25520

25521

<description>Place an object onto the screen</description>

25522

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25523

<param name="depth" required="1" vallist="0" default="" type="int">depth</param>

25524

25525

<insert>swf_placeobject(int objid, int depth);</insert>

25526

<dialog title="Insert swf_placeobject">swf_placeobject(%0, %1);</dialog>

25527

25528

</function>

25529

25530

25531

Define the viewer's position with polar coordinates

25532

</description>

25533

25534

<param name="azimuth" required="1" vallist="0" default="" type="float">azimuth</param>

25535

<param name="incidence" required="1" vallist="0" default="" type="float">incidence</param>

25536

<param name="twist" required="1" vallist="0" default="" type="float">twist</param>

25537

25538

<insert>swf_polarview(float dist, float azimuth, float incidence, float twist);</insert>

25539

<dialog title="Insert swf_polarview">swf_polarview(%0, %1, %2, %3);</dialog>

25540

25541

</function>

25542

25543

25544

Restore a previous transformation matrix

25545

</description>

25546

25547

<insert>swf_popmatrix();</insert>

25548

<dialog title="Insert swf_popmatrix">swf_popmatrix();</dialog>

25549

25550

</function>

25551

25552

25553

Enables or Disables the rounding of the translation when objects

25554

are placed or moved

25555

</description>

25556

<param name="round" required="1" vallist="0" default="" type="int">round</param>

25557

25558

<insert>swf_posround(int round);</insert>

25559

<dialog title="Insert swf_posround">swf_posround(%0);</dialog>

25560

25561

</function>

25562

25563

25564

Push the current transformation matrix back unto the stack

25565

</description>

25566

25567

<insert>swf_pushmatrix();</insert>

25568

<dialog title="Insert swf_pushmatrix">swf_pushmatrix();</dialog>

25569

25570

</function>

25571

25572

<description>Remove an object</description>

25573

<param name="depth" required="1" vallist="0" default="" type="int">depth</param>

25574

25575

<insert>swf_removeobject(int depth);</insert>

25576

<dialog title="Insert swf_removeobject">swf_removeobject(%0);</dialog>

25577

25578

</function>

25579

25580

<description>Rotate the current transformation</description>

25581

<param name="angle" required="1" vallist="0" default="" type="float">angle</param>

25582

25583

25584

<insert>swf_rotate(float angle, string axis);</insert>

25585

<dialog title="Insert swf_rotate">swf_rotate(%0, %1);</dialog>

25586

25587

</function>

25588

25589

<description>Scale the current transformation</description>

25590

25591

25592

25593

25594

<insert>swf_scale(float x, float y, float z);</insert>

25595

<dialog title="Insert swf_scale">swf_scale(%0, %1, %2);</dialog>

25596

25597

</function>

25598

25599

<description>Change the current font</description>

25600

<param name="fontid" required="1" vallist="0" default="" type="int">fontid</param>

25601

25602

<insert>swf_setfont(int fontid);</insert>

25603

<dialog title="Insert swf_setfont">swf_setfont(%0);</dialog>

25604

25605

</function>

25606

25607

<description>Switch to a specified frame</description>

25608

<param name="framenumber" required="1" vallist="0" default="" type="int">framenumber</param>

25609

25610

<insert>swf_setframe(int framenumber);</insert>

25611

<dialog title="Insert swf_setframe">swf_setframe(%0);</dialog>

25612

25613

</function>

25614

25615

<description>Draw a circular arc</description>

25616

25617

25618

25619

25620

25621

25622

<insert>swf_shapearc(float x, float y, float r, float ang1, float ang2);</insert>

25623

<dialog title="Insert swf_shapearc">swf_shapearc(%0, %1, %2, %3, %4);</dialog>

25624

25625

</function>

25626

25627

25628

Draw a quadratic bezier curve between two points

25629

</description>

25630

25631

25632

25633

25634

25635

<insert>swf_shapecurveto(float x1, float y1, float x2, float y2);</insert>

25636

<dialog title="Insert swf_shapecurveto">swf_shapecurveto(%0, %1, %2, %3);</dialog>

25637

25638

</function>

25639

25640

<description>Draw a cubic bezier curve</description>

25641

25642

25643

25644

25645

25646

25647

25648

<insert>swf_shapecurveto3(float x1, float y1, float x2, float y2, float x3, float y3);</insert>

25649

<dialog title="Insert swf_shapecurveto3">swf_shapecurveto3(%0, %1, %2, %3, %4, %5);</dialog>

25650

25651

</function>

25652

25653

25654

Set current fill mode to clipped bitmap

25655

</description>

25656

<param name="bitmapid" required="1" vallist="0" default="" type="int">bitmapid</param>

25657

25658

<insert>swf_shapefillbitmapclip(int bitmapid);</insert>

25659

<dialog title="Insert swf_shapefillbitmapclip">swf_shapefillbitmapclip(%0);</dialog>

25660

25661

</function>

25662

25663

25664

Set current fill mode to tiled bitmap

25665

</description>

25666

<param name="bitmapid" required="1" vallist="0" default="" type="int">bitmapid</param>

25667

25668

<insert>swf_shapefillbitmaptile(int bitmapid);</insert>

25669

<dialog title="Insert swf_shapefillbitmaptile">swf_shapefillbitmaptile(%0);</dialog>

25670

25671

</function>

25672

25673

<description>Turns off filling</description>

25674

25675

<insert>swf_shapefilloff();</insert>

25676

<dialog title="Insert swf_shapefilloff">swf_shapefilloff();</dialog>

25677

25678

</function>

25679

25680

25681

Set the current fill style to the specified color

25682

</description>

25683

25684

25685

25686

25687

25688

<insert>swf_shapefillsolid(float r, float g, float b, float a);</insert>

25689

<dialog title="Insert swf_shapefillsolid">swf_shapefillsolid(%0, %1, %2, %3);</dialog>

25690

25691

</function>

25692

25693

<description>Set the current line style</description>

25694

25695

25696

25697

25698

<param name="width" required="1" vallist="0" default="" type="float">width</param>

25699

25700

<insert>swf_shapelinesolid(float r, float g, float b, float a, float width);</insert>

25701

<dialog title="Insert swf_shapelinesolid">swf_shapelinesolid(%0, %1, %2, %3, %4);</dialog>

25702

25703

</function>

25704

25705

25706

25707

25708

25709

<insert>swf_shapelineto(float x, float y);</insert>

25710

<dialog title="Insert swf_shapelineto">swf_shapelineto(%0, %1);</dialog>

25711

25712

</function>

25713

25714

<description>Move the current position</description>

25715

25716

25717

25718

<insert>swf_shapemoveto(float x, float y);</insert>

25719

<dialog title="Insert swf_shapemoveto">swf_shapemoveto(%0, %1);</dialog>

25720

25721

</function>

25722

25723

<description>Display the current frame</description>

25724

25725

<insert>swf_showframe();</insert>

25726

<dialog title="Insert swf_showframe">swf_showframe();</dialog>

25727

25728

</function>

25729

25730

<description>Start the definition of a button</description>

25731

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25732

25733

25734

<insert>swf_startbutton(int objid, int type);</insert>

25735

<dialog title="Insert swf_startbutton">swf_startbutton(%0, %1);</dialog>

25736

25737

</function>

25738

25739

25740

Start a description of an action list for the current frame

25741

</description>

25742

25743

<insert>swf_startdoaction();</insert>

25744

<dialog title="Insert swf_startdoaction">swf_startdoaction();</dialog>

25745

25746

</function>

25747

25748

<description>Start a complex shape</description>

25749

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25750

25751

<insert>swf_startshape(int objid);</insert>

25752

<dialog title="Insert swf_startshape">swf_startshape(%0);</dialog>

25753

25754

</function>

25755

25756

<description>Define a symbol</description>

25757

<param name="objid" required="1" vallist="0" default="" type="int">objid</param>

25758

25759

<insert>swf_startsymbol(int objid);</insert>

25760

<dialog title="Insert swf_startsymbol">swf_startsymbol(%0);</dialog>

25761

25762

</function>

25763

25764

<description>Get the width of a string</description>

25765

25766

<return type="float">float</return>

25767

<insert>swf_textwidth(string str);</insert>

25768

<dialog title="Insert swf_textwidth">swf_textwidth(%0);</dialog>

25769

25770

</function>

25771

25772

<description>Translate the current transformations</description>

25773

25774

25775

25776

25777

<insert>swf_translate(float x, float y, float z);</insert>

25778

<dialog title="Insert swf_translate">swf_translate(%0, %1, %2);</dialog>

25779

25780

</function>

25781

25782

<description>Select an area for future drawing</description>

25783

25784

25785

25786

25787

25788

<insert>swf_viewport(float xmin, float xmax, float ymin, float ymax);</insert>

25789

<dialog title="Insert swf_viewport">swf_viewport(%0, %1, %2, %3);</dialog>

25790

25791

</function>

25792

</group>

25793

25794

25795

<description>get number of affected rows in last query</description>

25796

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

25797

25798

<insert>sybase_affected_rows([int link_identifier]);</insert>

25799

<dialog title="Insert sybase_affected_rows">sybase_affected_rows(%0);</dialog>

25800

25801

</function>

25802

25803

<description>close Sybase connection</description>

25804

<param name="link_identifier" required="0" vallist="0" default="" type="int">link_identifier</param>

25805

25806

<insert>sybase_close([int link_identifier]);</insert>

25807

<dialog title="Insert sybase_close">sybase_close(%0);</dialog>

25808

25809

</function>

25810

25811

<description>open Sybase server connection</description>

25812

<param name="servername" required="1" vallist="0" default="" type="string">servername</param>

25813

<param name="username" required="1" vallist="0" default="" type="string">username</param>

25814

<param name="password" required="1" vallist="0" default="" type="string">password</param>

25815

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

25816

25817

<insert>sybase_connect(string servername, string username, string password [,string charset]);</insert>

25818

<dialog title="Insert sybase_connect">sybase_connect(%0, %1, %2, %3);</dialog>

25819

25820

</function>

25821

25822

<description>move internal row pointer</description>

25823

<param name="result_identifier" required="1" vallist="0" default="" type="int">result_identifier</param>

25824

<param name="row_number" required="1" vallist="0" default="" type="int">row_number</param>

25825

25826

<insert>sybase_data_seek(int result_identifier, int row_number);</insert>

25827

<dialog title="Insert sybase_data_seek">sybase_data_seek(%0, %1);</dialog>

25828

25829

</function>

25830

25831

<description>set the deadlock retry count</description>

25832

<param name="retry_count" required="1" vallist="0" default="" type="int">retry_count</param>

25833

25834

<insert>sybase_deadlock_retry_count(int retry_count);</insert>

25835

<dialog title="Insert sybase_deadlock_retry_count">sybase_deadlock_retry_count(%0);</dialog>

25836

25837

</function>

25838

25839

<description>fetch row as array</description>

25840

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25841

<return type="array">array</return>

25842

<insert>sybase_fetch_array(int result);</insert>

25843

<dialog title="Insert sybase_fetch_array">sybase_fetch_array(%0);</dialog>

25844

25845

</function>

25846

25847

<description>fetch row as associative array</description>

25848

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

25849

<return type="array">array</return>

25850

<insert>sybase_fetch_assoc(resource result);</insert>

25851

<dialog title="Insert sybase_fetch_assoc">sybase_fetch_assoc(%0);</dialog>

25852

25853

</function>

25854

25855

<description>get field information</description>

25856

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25857

<param name="field_offset" required="0" vallist="0" default="" type="int">field_offset</param>

25858

<return type="object">object</return>

25859

<insert>sybase_fetch_field(int result [,int field_offset]);</insert>

25860

<dialog title="Insert sybase_fetch_field">sybase_fetch_field(%0, %1);</dialog>

25861

25862

</function>

25863

25864

<description>fetch row as object</description>

25865

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25866

25867

<insert>sybase_fetch_object(int result);</insert>

25868

<dialog title="Insert sybase_fetch_object">sybase_fetch_object(%0);</dialog>

25869

25870

</function>

25871

25872

<description>get row as enumerated array</description>

25873

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25874

<return type="array">array</return>

25875

<insert>sybase_fetch_row(int result);</insert>

25876

<dialog title="Insert sybase_fetch_row">sybase_fetch_row(%0);</dialog>

25877

25878

</function>

25879

25880

<description>set field offset</description>

25881

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25882

<param name="field_offset" required="1" vallist="0" default="" type="int">field_offset</param>

25883

25884

<insert>sybase_field_seek(int result, int field_offset);</insert>

25885

<dialog title="Insert sybase_field_seek">sybase_field_seek(%0, %1);</dialog>

25886

25887

</function>

25888

25889

<description>free result memory</description>

25890

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25891

25892

<insert>sybase_free_result(int result);</insert>

25893

<dialog title="Insert sybase_free_result">sybase_free_result(%0);</dialog>

25894

25895

</function>

25896

25897

<description>Returns the last message from the server</description>

25898

<return type="string">string</return>

25899

<insert>sybase_get_last_message();</insert>

25900

<dialog title="Insert sybase_get_last_message">sybase_get_last_message();</dialog>

25901

25902

</function>

25903

25904

<description>Sets minimum client severity</description>

25905

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

25906

25907

<insert>sybase_min_client_severity(int severity);</insert>

25908

<dialog title="Insert sybase_min_client_severity">sybase_min_client_severity(%0);</dialog>

25909

25910

</function>

25911

25912

<description>Sets minimum error severity</description>

25913

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

25914

25915

<insert>sybase_min_error_severity(int severity);</insert>

25916

<dialog title="Insert sybase_min_error_severity">sybase_min_error_severity(%0);</dialog>

25917

25918

</function>

25919

25920

<description>Sets minimum message severity</description>

25921

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

25922

25923

<insert>sybase_min_message_severity(int severity);</insert>

25924

<dialog title="Insert sybase_min_message_severity">sybase_min_message_severity(%0);</dialog>

25925

25926

</function>

25927

25928

<description>Sets minimum server severity</description>

25929

<param name="severity" required="1" vallist="0" default="" type="int">severity</param>

25930

25931

<insert>sybase_min_server_severity(int severity);</insert>

25932

<dialog title="Insert sybase_min_server_severity">sybase_min_server_severity(%0);</dialog>

25933

25934

</function>

25935

25936

<description>get number of fields in result</description>

25937

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25938

25939

<insert>sybase_num_fields(int result);</insert>

25940

<dialog title="Insert sybase_num_fields">sybase_num_fields(%0);</dialog>

25941

25942

</function>

25943

25944

<description>Get number of rows in result</description>

25945

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25946

25947

<insert>sybase_num_rows(int result);</insert>

25948

<dialog title="Insert sybase_num_rows">sybase_num_rows(%0);</dialog>

25949

25950

</function>

25951

25952

<description>open persistent Sybase connection</description>

25953

<param name="servername" required="1" vallist="0" default="" type="string">servername</param>

25954

<param name="username" required="1" vallist="0" default="" type="string">username</param>

25955

<param name="password" required="1" vallist="0" default="" type="string">password</param>

25956

<param name="charset" required="0" vallist="0" default="" type="string">charset</param>

25957

25958

<insert>sybase_pconnect(string servername, string username, string password [,string charset]);</insert>

25959

<dialog title="Insert sybase_pconnect">sybase_pconnect(%0, %1, %2, %3);</dialog>

25960

25961

</function>

25962

25963

<description>Send Sybase query</description>

25964

<param name="query" required="1" vallist="0" default="" type="string">query</param>

25965

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

25966

25967

<insert>sybase_query(string query, int link_identifier);</insert>

25968

<dialog title="Insert sybase_query">sybase_query(%0, %1);</dialog>

25969

25970

</function>

25971

25972

<description>get result data</description>

25973

<param name="result" required="1" vallist="0" default="" type="int">result</param>

25974

25975

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

25976

<return type="string">string</return>

25977

<insert>sybase_result(int result, int row, mixed field);</insert>

25978

<dialog title="Insert sybase_result">sybase_result(%0, %1, %2);</dialog>

25979

25980

</function>

25981

25982

<description>select Sybase database</description>

25983

<param name="database_name" required="1" vallist="0" default="" type="string">database_name</param>

25984

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

25985

25986

<insert>sybase_select_db(string database_name, int link_identifier);</insert>

25987

<dialog title="Insert sybase_select_db">sybase_select_db(%0, %1);</dialog>

25988

25989

</function>

25990

25991

<description>set handler called when a server message is raised</description>

25992

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

25993

25994

<insert>sybase_set_message_handler(callback handler);</insert>

25995

<dialog title="Insert sybase_set_message_handler">sybase_set_message_handler(%0);</dialog>

25996

25997

</function>

25998

25999

<description>send Sybase query and do not block</description>

26000

<param name="query" required="1" vallist="0" default="" type="string">query</param>

26001

<param name="link_identifier" required="1" vallist="0" default="" type="int">link_identifier</param>

26002

<return type="resource">resource</return>

26003

<insert>sybase_unbuffered_query(string query, int link_identifier);</insert>

26004

<dialog title="Insert sybase_unbuffered_query">sybase_unbuffered_query(%0, %1);</dialog>

26005

26006

</function>

26007

</group>

26008

26009

26010

<description>Split given source into PHP tokens</description>

26011

<param name="source" required="1" vallist="0" default="" type="string">source</param>

26012

<return type="array">array</return>

26013

<insert>token_get_all(string source);</insert>

26014

<dialog title="Insert token_get_all">token_get_all(%0);</dialog>

26015

26016

</function>

26017

26018

<description>Get the symbolic name of a given PHP token</description>

26019

<param name="token" required="1" vallist="0" default="" type="int">token</param>

26020

<return type="string">string</return>

26021

<insert>token_name(int token);</insert>

26022

<dialog title="Insert token_name">token_name(%0);</dialog>

26023

26024

</function>

26025

</group>

26026

26027

26028

<description>Toggle autocommit behaviour</description>

26029

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26030

<param name="OnOff" required="0" vallist="0" default="" type="bool">OnOff</param>

26031

26032

<insert>odbc_autocommit(resource connection_id [,bool OnOff]);</insert>

26033

<dialog title="Insert odbc_autocommit">odbc_autocommit(%0, %1);</dialog>

26034

26035

</function>

26036

26037

<description>Handling of binary column data</description>

26038

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26039

26040

26041

<insert>odbc_binmode(resource result_id, int mode);</insert>

26042

<dialog title="Insert odbc_binmode">odbc_binmode(%0, %1);</dialog>

26043

26044

</function>

26045

26046

<description>Close all ODBC connections</description>

26047

26048

<insert>odbc_close_all();</insert>

26049

<dialog title="Insert odbc_close_all">odbc_close_all();</dialog>

26050

26051

</function>

26052

26053

<description>Close an ODBC connection</description>

26054

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26055

26056

<insert>odbc_close(resource connection_id);</insert>

26057

<dialog title="Insert odbc_close">odbc_close(%0);</dialog>

26058

26059

</function>

26060

26061

26062

Returns a result identifier that can be used to fetch a list of

26063

columns and associated privileges

26064

</description>

26065

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26066

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26067

<param name="owner" required="0" vallist="0" default="" type="string">owner</param>

26068

<param name="table_name" required="0" vallist="0" default="" type="string">table_name</param>

26069

<param name="column_name" required="0" vallist="0" default="" type="string">column_name</param>

26070

26071

<insert>odbc_columnprivileges(resource connection_id [,string qualifier] [,string owner] [,string table_name] [,string column_name]);</insert>

26072

<dialog title="Insert odbc_columnprivileges">odbc_columnprivileges(%0, %1, %2, %3, %4);</dialog>

26073

26074

</function>

26075

26076

26077

Lists the column names in specified tables. Returns a result

26078

identifier containing the information.

26079

</description>

26080

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26081

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26082

<param name="schema" required="0" vallist="0" default="" type="string">schema</param>

26083

<param name="table_name" required="0" vallist="0" default="" type="string">table_name</param>

26084

<param name="column_name" required="0" vallist="0" default="" type="string">column_name</param>

26085

<return type="resource">resource</return>

26086

<insert>odbc_columns(resource connection_id [,string qualifier] [,string schema] [,string table_name] [,string column_name]);</insert>

26087

<dialog title="Insert odbc_columns">odbc_columns(%0, %1, %2, %3, %4);</dialog>

26088

26089

</function>

26090

26091

<description>Commit an ODBC transaction</description>

26092

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26093

26094

<insert>odbc_commit(resource connection_id);</insert>

26095

<dialog title="Insert odbc_commit">odbc_commit(%0);</dialog>

26096

26097

</function>

26098

26099

<description>Connect to a datasource</description>

26100

26101

26102

<param name="password" required="1" vallist="0" default="" type="string">password</param>

26103

<param name="cursor_type" required="0" vallist="0" default="" type="int">cursor_type</param>

26104

<return type="resource">resource</return>

26105

<insert>odbc_connect(string dsn, string user, string password [,int cursor_type]);</insert>

26106

<dialog title="Insert odbc_connect">odbc_connect(%0, %1, %2, %3);</dialog>

26107

26108

</function>

26109

26110

<description>Get cursorname</description>

26111

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26112

<return type="string">string</return>

26113

<insert>odbc_cursor(resource result_id);</insert>

26114

<dialog title="Insert odbc_cursor">odbc_cursor(%0);</dialog>

26115

26116

</function>

26117

26118

<description>Returns information about a current connection</description>

26119

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26120

<param name="fetch_type" required="1" vallist="0" default="" type="constant">fetch_type</param>

26121

<return type="resource">resource</return>

26122

<insert>odbc_data_source(resource connection_id, constant fetch_type);</insert>

26123

<dialog title="Insert odbc_data_source">odbc_data_source(%0, %1);</dialog>

26124

26125

</function>

26126

26127

<description>Synonym for </description>

26128

26129

<param name="query" required="1" vallist="0" default="" type="string">query</param>

26130

<return type="resource">resource</return>

26131

<insert>odbc_do(resource conn_id, string query);</insert>

26132

26133

26134

</function>

26135

26136

<description>Get the last error code</description>

26137

<param name="connection_id" required="0" vallist="0" default="" type="resource">connection_id</param>

26138

<return type="string">string</return>

26139

<insert>odbc_error([resource connection_id]);</insert>

26140

<dialog title="Insert odbc_error">odbc_error(%0);</dialog>

26141

26142

</function>

26143

26144

<description>Get the last error message</description>

26145

<param name="connection_id" required="0" vallist="0" default="" type="resource">connection_id</param>

26146

<return type="string">string</return>

26147

<insert>odbc_errormsg([resource connection_id]);</insert>

26148

<dialog title="Insert odbc_errormsg">odbc_errormsg(%0);</dialog>

26149

26150

</function>

26151

26152

<description>Prepare and execute a SQL statement</description>

26153

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26154

<param name="query_string" required="1" vallist="0" default="" type="string">query_string</param>

26155

<return type="resource">resource</return>

26156

<insert>odbc_exec(resource connection_id, string query_string);</insert>

26157

26158

26159

</function>

26160

26161

<description>Execute a prepared statement</description>

26162

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26163

<param name="parameters_array" required="0" vallist="0" default="" type="array">parameters_array</param>

26164

26165

<insert>odbc_execute(resource result_id [,array parameters_array]);</insert>

26166

<dialog title="Insert odbc_execute">odbc_execute(%0, %1);</dialog>

26167

26168

</function>

26169

26170

26171

Fetch a result row as an associative array

26172

</description>

26173

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

26174

<param name="rownumber" required="0" vallist="0" default="" type="int">rownumber</param>

26175

<return type="array">array</return>

26176

<insert>odbc_fetch_array(resource result [,int rownumber]);</insert>

26177

<dialog title="Insert odbc_fetch_array">odbc_fetch_array(%0, %1);</dialog>

26178

26179

</function>

26180

26181

<description>Fetch one result row into array</description>

26182

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26183

<param name="rownumber" required="0" vallist="0" default="" type="int">rownumber</param>

26184

<param name="result_array" required="1" vallist="0" default="" type="array">result_array</param>

26185

26186

<insert>odbc_fetch_into(resource result_id [,int rownumber], array result_array);</insert>

26187

<dialog title="Insert odbc_fetch_into">odbc_fetch_into(%0, %1, %2);</dialog>

26188

26189

</function>

26190

26191

26192

Fetch a result row as an object

26193

</description>

26194

<param name="result" required="1" vallist="0" default="" type="resource">result</param>

26195

<param name="rownumber" required="0" vallist="0" default="" type="int">rownumber</param>

26196

<return type="object">object</return>

26197

<insert>odbc_fetch_object(resource result [,int rownumber]);</insert>

26198

<dialog title="Insert odbc_fetch_object">odbc_fetch_object(%0, %1);</dialog>

26199

26200

</function>

26201

26202

<description>Fetch a row</description>

26203

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26204

<param name="row_number" required="0" vallist="0" default="" type="int">row_number</param>

26205

26206

<insert>odbc_fetch_row(resource result_id [,int row_number]);</insert>

26207

<dialog title="Insert odbc_fetch_row">odbc_fetch_row(%0, %1);</dialog>

26208

26209

</function>

26210

26211

<description>Get the length (precision) of a field</description>

26212

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26213

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

26214

26215

<insert>odbc_field_len(resource result_id, int field_number);</insert>

26216

<dialog title="Insert odbc_field_len">odbc_field_len(%0, %1);</dialog>

26217

26218

</function>

26219

26220

<description>Get the columnname</description>

26221

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26222

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

26223

<return type="string">string</return>

26224

<insert>odbc_field_name(resource result_id, int field_number);</insert>

26225

<dialog title="Insert odbc_field_name">odbc_field_name(%0, %1);</dialog>

26226

26227

</function>

26228

26229

<description>Return column number</description>

26230

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26231

<param name="field_name" required="1" vallist="0" default="" type="string">field_name</param>

26232

26233

<insert>odbc_field_num(resource result_id, string field_name);</insert>

26234

<dialog title="Insert odbc_field_num">odbc_field_num(%0, %1);</dialog>

26235

26236

</function>

26237

26238

<description>Synonym for </description>

26239

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26240

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

26241

<return type="string">string</return>

26242

<insert>odbc_field_precision(resource result_id, int field_number);</insert>

26243

<dialog title="Insert odbc_field_precision">odbc_field_precision(%0, %1);</dialog>

26244

26245

</function>

26246

26247

<description>Get the scale of a field</description>

26248

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26249

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

26250

<return type="string">string</return>

26251

<insert>odbc_field_scale(resource result_id, int field_number);</insert>

26252

<dialog title="Insert odbc_field_scale">odbc_field_scale(%0, %1);</dialog>

26253

26254

</function>

26255

26256

<description>Datatype of a field</description>

26257

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26258

<param name="field_number" required="1" vallist="0" default="" type="int">field_number</param>

26259

<return type="string">string</return>

26260

<insert>odbc_field_type(resource result_id, int field_number);</insert>

26261

<dialog title="Insert odbc_field_type">odbc_field_type(%0, %1);</dialog>

26262

26263

</function>

26264

26265

26266

Returns a list of foreign keys in the specified table or a list

26267

of foreign keys in other tables that refer to the primary key in

26268

the specified table

26269

</description>

26270

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26271

<param name="pk_qualifier" required="1" vallist="0" default="" type="string">pk_qualifier</param>

26272

<param name="pk_owner" required="1" vallist="0" default="" type="string">pk_owner</param>

26273

<param name="pk_table" required="1" vallist="0" default="" type="string">pk_table</param>

26274

<param name="fk_qualifier" required="1" vallist="0" default="" type="string">fk_qualifier</param>

26275

<param name="fk_owner" required="1" vallist="0" default="" type="string">fk_owner</param>

26276

<param name="fk_table" required="1" vallist="0" default="" type="string">fk_table</param>

26277

<return type="resource">resource</return>

26278

<insert>odbc_foreignkeys(resource connection_id, string pk_qualifier, string pk_owner, string pk_table, string fk_qualifier, string fk_owner, string fk_table);</insert>

26279

<dialog title="Insert odbc_foreignkeys">odbc_foreignkeys(%0, %1, %2, %3, %4, %5, %6);</dialog>

26280

26281

</function>

26282

26283

<description>Free resources associated with a result</description>

26284

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26285

26286

<insert>odbc_free_result(resource result_id);</insert>

26287

<dialog title="Insert odbc_free_result">odbc_free_result(%0);</dialog>

26288

26289

</function>

26290

26291

26292

Returns a result identifier containing information about data

26293

types supported by the data source.

26294

</description>

26295

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26296

26297

26298

<insert>odbc_gettypeinfo(resource connection_id [,int data_type]);</insert>

26299

<dialog title="Insert odbc_gettypeinfo">odbc_gettypeinfo(%0, %1);</dialog>

26300

26301

</function>

26302

26303

<description>Handling of LONG columns</description>

26304

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26305

<param name="length" required="1" vallist="0" default="" type="int">length</param>

26306

26307

<insert>odbc_longreadlen(resource result_id, int length);</insert>

26308

<dialog title="Insert odbc_longreadlen">odbc_longreadlen(%0, %1);</dialog>

26309

26310

</function>

26311

26312

26313

Checks if multiple results are avaiable

26314

</description>

26315

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26316

26317

<insert>odbc_next_result(resource result_id);</insert>

26318

<dialog title="Insert odbc_next_result">odbc_next_result(%0);</dialog>

26319

26320

</function>

26321

26322

<description>Number of columns in a result</description>

26323

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26324

26325

<insert>odbc_num_fields(resource result_id);</insert>

26326

<dialog title="Insert odbc_num_fields">odbc_num_fields(%0);</dialog>

26327

26328

</function>

26329

26330

<description>Number of rows in a result</description>

26331

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26332

26333

<insert>odbc_num_rows(resource result_id);</insert>

26334

26335

26336

</function>

26337

26338

<description>Open a persistent database connection</description>

26339

26340

26341

<param name="password" required="1" vallist="0" default="" type="string">password</param>

26342

<param name="cursor_type" required="0" vallist="0" default="" type="int">cursor_type</param>

26343

<return type="resource">resource</return>

26344

<insert>odbc_pconnect(string dsn, string user, string password [,int cursor_type]);</insert>

26345

<dialog title="Insert odbc_pconnect">odbc_pconnect(%0, %1, %2, %3);</dialog>

26346

26347

</function>

26348

26349

<description>Prepares a statement for execution</description>

26350

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26351

<param name="query_string" required="1" vallist="0" default="" type="string">query_string</param>

26352

<return type="resource">resource</return>

26353

<insert>odbc_prepare(resource connection_id, string query_string);</insert>

26354

<dialog title="Insert odbc_prepare">odbc_prepare(%0, %1);</dialog>

26355

26356

</function>

26357

26358

26359

Returns a result identifier that can be used to fetch the column

26360

names that comprise the primary key for a table

26361

</description>

26362

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26363

<param name="qualifier" required="1" vallist="0" default="" type="string">qualifier</param>

26364

<param name="owner" required="1" vallist="0" default="" type="string">owner</param>

26365

<param name="table" required="1" vallist="0" default="" type="string">table</param>

26366

<return type="resource">resource</return>

26367

<insert>odbc_primarykeys(resource connection_id, string qualifier, string owner, string table);</insert>

26368

<dialog title="Insert odbc_primarykeys">odbc_primarykeys(%0, %1, %2, %3);</dialog>

26369

26370

</function>

26371

26372

26373

Retrieve information about parameters to procedures

26374

</description>

26375

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26376

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26377

<param name="owner" required="0" vallist="0" default="" type="string">owner</param>

26378

26379

<param name="column" required="0" vallist="0" default="" type="string">column</param>

26380

<return type="resource">resource</return>

26381

<insert>odbc_procedurecolumns(resource connection_id [,string qualifier] [,string owner] [,string proc] [,string column]);</insert>

26382

<dialog title="Insert odbc_procedurecolumns">odbc_procedurecolumns(%0, %1, %2, %3, %4);</dialog>

26383

26384

</function>

26385

26386

26387

Get the list of procedures stored in a specific data source.

26388

Returns a result identifier containing the information.

26389

</description>

26390

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26391

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26392

<param name="owner" required="0" vallist="0" default="" type="string">owner</param>

26393

26394

<return type="resource">resource</return>

26395

<insert>odbc_procedures(resource connection_id [,string qualifier] [,string owner] [,string name]);</insert>

26396

<dialog title="Insert odbc_procedures">odbc_procedures(%0, %1, %2, %3);</dialog>

26397

26398

</function>

26399

26400

<description>Print result as HTML table</description>

26401

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26402

<param name="format" required="0" vallist="0" default="" type="string">format</param>

26403

26404

<insert>odbc_result_all(resource result_id [,string format]);</insert>

26405

<dialog title="Insert odbc_result_all">odbc_result_all(%0, %1);</dialog>

26406

26407

</function>

26408

26409

<description>Get result data</description>

26410

<param name="result_id" required="1" vallist="0" default="" type="resource">result_id</param>

26411

<param name="field" required="1" vallist="0" default="" type="mixed">field</param>

26412

<return type="string">string</return>

26413

<insert>odbc_result(resource result_id, mixed field);</insert>

26414

<dialog title="Insert odbc_result">odbc_result(%0, %1);</dialog>

26415

26416

</function>

26417

26418

<description>Rollback a transaction</description>

26419

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26420

26421

<insert>odbc_rollback(resource connection_id);</insert>

26422

<dialog title="Insert odbc_rollback">odbc_rollback(%0);</dialog>

26423

26424

</function>

26425

26426

26427

Adjust ODBC settings. Returns </description>

26428

26429

<param name="function" required="1" vallist="0" default="" type="int">function</param>

26430

<param name="option" required="1" vallist="0" default="" type="int">option</param>

26431

<param name="param" required="1" vallist="0" default="" type="int">param</param>

26432

26433

<insert>odbc_setoption(resource id, int function, int option, int param);</insert>

26434

<dialog title="Insert odbc_setoption">odbc_setoption(%0, %1, %2, %3);</dialog>

26435

26436

</function>

26437

26438

26439

Returns either the optimal set of columns that uniquely

26440

identifies a row in the table or columns that are automatically

26441

updated when any value in the row is updated by a transaction

26442

</description>

26443

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26444

26445

<param name="qualifier" required="1" vallist="0" default="" type="string">qualifier</param>

26446

<param name="owner" required="1" vallist="0" default="" type="string">owner</param>

26447

<param name="table" required="1" vallist="0" default="" type="string">table</param>

26448

<param name="scope" required="1" vallist="0" default="" type="int">scope</param>

26449

<param name="nullable" required="1" vallist="0" default="" type="int">nullable</param>

26450

<return type="resource">resource</return>

26451

<insert>odbc_specialcolumns(resource connection_id, int type, string qualifier, string owner, string table, int scope, int nullable);</insert>

26452

<dialog title="Insert odbc_specialcolumns">odbc_specialcolumns(%0, %1, %2, %3, %4, %5, %6);</dialog>

26453

26454

</function>

26455

26456

<description>Retrieve statistics about a table</description>

26457

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26458

<param name="qualifier" required="1" vallist="0" default="" type="string">qualifier</param>

26459

<param name="owner" required="1" vallist="0" default="" type="string">owner</param>

26460

<param name="table_name" required="1" vallist="0" default="" type="string">table_name</param>

26461

<param name="unique" required="1" vallist="0" default="" type="int">unique</param>

26462

<param name="accuracy" required="1" vallist="0" default="" type="int">accuracy</param>

26463

<return type="resource">resource</return>

26464

<insert>odbc_statistics(resource connection_id, string qualifier, string owner, string table_name, int unique, int accuracy);</insert>

26465

<dialog title="Insert odbc_statistics">odbc_statistics(%0, %1, %2, %3, %4, %5);</dialog>

26466

26467

</function>

26468

26469

26470

Lists tables and the privileges associated with each table

26471

</description>

26472

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26473

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26474

<param name="owner" required="0" vallist="0" default="" type="string">owner</param>

26475

26476

26477

<insert>odbc_tableprivileges(resource connection_id [,string qualifier] [,string owner] [,string name]);</insert>

26478

<dialog title="Insert odbc_tableprivileges">odbc_tableprivileges(%0, %1, %2, %3);</dialog>

26479

26480

</function>

26481

26482

26483

Get the list of table names stored in a specific data source.

26484

Returns a result identifier containing the

26485

information.

26486

</description>

26487

<param name="connection_id" required="1" vallist="0" default="" type="resource">connection_id</param>

26488

<param name="qualifier" required="0" vallist="0" default="" type="string">qualifier</param>

26489

<param name="owner" required="0" vallist="0" default="" type="string">owner</param>

26490

26491

<param name="types" required="0" vallist="0" default="" type="string">types</param>

26492

26493

<insert>odbc_tables(resource connection_id [,string qualifier] [,string owner] [,string name] [,string types]);</insert>

26494

<dialog title="Insert odbc_tables">odbc_tables(%0, %1, %2, %3, %4);</dialog>

26495

26496

</function>

26497

</group>

26498

26499

26500

<description>Decodes data encoded with MIME base64</description>

26501

<param name="encoded_data" required="1" vallist="0" default="" type="string">encoded_data</param>

26502

<return type="string">string</return>

26503

<insert>base64_decode(string encoded_data);</insert>

26504

<dialog title="Insert base64_decode">base64_decode(%0);</dialog>

26505

26506

</function>

26507

26508

<description>Encodes data with MIME base64</description>

26509

26510

<return type="string">string</return>

26511

<insert>base64_encode(string data);</insert>

26512

<dialog title="Insert base64_encode">base64_encode(%0);</dialog>

26513

26514

</function>

26515

26516

26517

Extracts all meta tag content attributes from a file and returns

26518

an array

26519

</description>

26520

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

26521

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

26522

<return type="array">array</return>

26523

<insert>get_meta_tags(string filename [,int use_include_path]);</insert>

26524

26525

26526

</function>

26527

26528

<description>Parse a URL and return its components</description>

26529

26530

<return type="array">array</return>

26531

<insert>parse_url(string url);</insert>

26532

<dialog title="Insert parse_url">parse_url(%0);</dialog>

26533

26534

</function>

26535

26536

<description>Decode URL-encoded strings</description>

26537

26538

<return type="string">string</return>

26539

<insert>rawurldecode(string str);</insert>

26540

<dialog title="Insert rawurldecode">rawurldecode(%0);</dialog>

26541

26542

</function>

26543

26544

<description>URL-encode according to RFC 1738</description>

26545

26546

<return type="string">string</return>

26547

<insert>rawurlencode(string str);</insert>

26548

<dialog title="Insert rawurlencode">rawurlencode(%0);</dialog>

26549

26550

</function>

26551

26552

<description>Decodes URL-encoded string</description>

26553

26554

<return type="string">string</return>

26555

<insert>urldecode(string str);</insert>

26556

<dialog title="Insert urldecode">urldecode(%0);</dialog>

26557

26558

</function>

26559

26560

<description>URL-encodes string</description>

26561

26562

<return type="string">string</return>

26563

<insert>urlencode(string str);</insert>

26564

<dialog title="Insert urlencode">urlencode(%0);</dialog>

26565

26566

</function>

26567

</group>

26568

26569

26570

<description>Determine whether a variable is set</description>

26571

26572

26573

<insert>empty(mixed var);</insert>

26574

<dialog title="Insert empty">empty(%0);</dialog>

26575

26576

</function>

26577

26578

<description>Get float value of a variable</description>

26579

26580

<return type="float">float</return>

26581

<insert>floatval(mixed var);</insert>

26582

<dialog title="Insert floatval">floatval(%0);</dialog>

26583

26584

</function>

26585

26586

26587

Returns an array of all defined variables

26588

</description>

26589

<return type="array">array</return>

26590

<insert>get_defined_vars();</insert>

26591

<dialog title="Insert get_defined_vars">get_defined_vars();</dialog>

26592

26593

</function>

26594

26595

26596

Returns the resource type

26597

</description>

26598

<param name="handle" required="1" vallist="0" default="" type="resource">handle</param>

26599

<return type="string">string</return>

26600

<insert>get_resource_type(resource handle);</insert>

26601

<dialog title="Insert get_resource_type">get_resource_type(%0);</dialog>

26602

26603

</function>

26604

26605

<description>Get the type of a variable</description>

26606

26607

<return type="string">string</return>

26608

<insert>gettype(mixed var);</insert>

26609

<dialog title="Insert gettype">gettype(%0);</dialog>

26610

26611

</function>

26612

26613

<description>Import GET/POST/Cookie variables into the global scope</description>

26614

<param name="types" required="1" vallist="0" default="" type="string">types</param>

26615

<param name="prefix" required="0" vallist="0" default="" type="string">prefix</param>

26616

26617

<insert>import_request_variables(string types [,string prefix]);</insert>

26618

<dialog title="Insert import_request_variables">import_request_variables(%0, %1);</dialog>

26619

26620

</function>

26621

26622

<description>Get integer value of a variable</description>

26623

26624

26625

26626

<insert>intval(mixed var [,int base]);</insert>

26627

<dialog title="Insert intval">intval(%0, %1);</dialog>

26628

26629

</function>

26630

26631

<description>Finds whether a variable is an array</description>

26632

26633

26634

<insert>is_array(mixed var);</insert>

26635

<dialog title="Insert is_array">is_array(%0);</dialog>

26636

26637

</function>

26638

26639

26640

Finds out whether a variable is a boolean

26641

</description>

26642

26643

26644

<insert>is_bool(mixed var);</insert>

26645

26646

26647

</function>

26648

26649

26650

Find out whether the argument is a valid callable construct

26651

</description>

26652

26653

<param name="syntax_only" required="0" vallist="0" default="" type="bool">syntax_only</param>

26654

<param name="callable_name" required="0" vallist="0" default="" type="string">callable_name</param>

26655

26656

<insert>is_callable(mixed var [,bool syntax_only] [,string callable_name]);</insert>

26657

<dialog title="Insert is_callable">is_callable(%0, %1, %2);</dialog>

26658

26659

</function>

26660

26661

<description>Finds whether a variable is a float</description>

26662

26663

26664

<insert>is_float(mixed var);</insert>

26665

<dialog title="Insert is_float">is_float(%0);</dialog>

26666

26667

</function>

26668

26669

<description>Find whether a variable is an integer</description>

26670

26671

26672

<insert>is_int(mixed var);</insert>

26673

26674

26675

</function>

26676

26677

26678

Finds whether a variable is </description>

26679

26680

26681

<insert>is_null(mixed var);</insert>

26682

26683

26684

</function>

26685

26686

26687

Finds whether a variable is a number or a numeric string

26688

</description>

26689

26690

26691

<insert>is_numeric(mixed var);</insert>

26692

<dialog title="Insert is_numeric">is_numeric(%0);</dialog>

26693

26694

</function>

26695

26696

<description>Finds whether a variable is an object</description>

26697

26698

26699

<insert>is_object(mixed var);</insert>

26700

<dialog title="Insert is_object">is_object(%0);</dialog>

26701

26702

</function>

26703

26704

26705

Finds whether a variable is a resource

26706

</description>

26707

26708

26709

<insert>is_resource(mixed var);</insert>

26710

<dialog title="Insert is_resource">is_resource(%0);</dialog>

26711

26712

</function>

26713

26714

26715

Finds whether a variable is a scalar

26716

</description>

26717

26718

26719

<insert>is_scalar(mixed var);</insert>

26720

<dialog title="Insert is_scalar">is_scalar(%0);</dialog>

26721

26722

</function>

26723

26724

<description>Finds whether a variable is a string</description>

26725

26726

26727

<insert>is_string(mixed var);</insert>

26728

<dialog title="Insert is_string">is_string(%0);</dialog>

26729

26730

</function>

26731

26732

<description>Determine whether a variable is set</description>

26733

26734

26735

26736

<insert>isset(mixed var [,mixed var]);</insert>

26737

<dialog title="Insert isset">isset(%0, %1);</dialog>

26738

26739

</function>

26740

26741

26742

Prints human-readable information about a variable

26743

</description>

26744

<param name="expression" required="1" vallist="0" default="" type="mixed">expression</param>

26745

26746

<insert>print_r(mixed expression);</insert>

26747

<dialog title="Insert print_r">print_r(%0);</dialog>

26748

26749

</function>

26750

26751

26752

Generates a storable representation of a value

26753

</description>

26754

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

26755

<return type="string">string</return>

26756

<insert>serialize(mixed value);</insert>

26757

<dialog title="Insert serialize">serialize(%0);</dialog>

26758

26759

</function>

26760

26761

<description>Set the type of a variable</description>

26762

26763

26764

26765

<insert>settype(mixed var, string type);</insert>

26766

<dialog title="Insert settype">settype(%0, %1);</dialog>

26767

26768

</function>

26769

26770

<description>Get string value of a variable</description>

26771

26772

<return type="string">string</return>

26773

<insert>strval(mixed var);</insert>

26774

<dialog title="Insert strval">strval(%0);</dialog>

26775

26776

</function>

26777

26778

26779

Creates a PHP value from a stored representation

26780

</description>

26781

26782

<param name="callback" required="0" vallist="0" default="" type="string">callback</param>

26783

<return type="mixed">mixed</return>

26784

<insert>unserialize(string str [,string callback]);</insert>

26785

<dialog title="Insert unserialize">unserialize(%0, %1);</dialog>

26786

26787

</function>

26788

26789

<description>Unset a given variable</description>

26790

26791

26792

26793

<insert>unset(mixed var [,mixed var]);</insert>

26794

<dialog title="Insert unset">unset(%0, %1);</dialog>

26795

26796

</function>

26797

26798

<description>Dumps information about a variable</description>

26799

<param name="expression" required="1" vallist="0" default="" type="mixed">expression</param>

26800

<param name="expression" required="0" vallist="0" default="" type="mixed">expression</param>

26801

26802

<insert>var_dump(mixed expression [,mixed expression]);</insert>

26803

26804

26805

</function>

26806

26807

<description>Outputs or returns a string representation of a variable</description>

26808

<param name="expression" required="1" vallist="0" default="" type="mixed">expression</param>

26809

<param name="return" required="0" vallist="0" default="" type="bool">return</param>

26810

<return type="mixed">mixed</return>

26811

<insert>var_export(mixed expression [,bool return]);</insert>

26812

<dialog title="Insert var_export">var_export(%0, %1);</dialog>

26813

26814

</function>

26815

</group>

26816

26817

26818

<description>Add alias to an existing virtual domain</description>

26819

<param name="olddomain" required="1" vallist="0" default="" type="string">olddomain</param>

26820

<param name="newdomain" required="1" vallist="0" default="" type="string">newdomain</param>

26821

26822

<insert>vpopmail_add_alias_domain_ex(string olddomain, string newdomain);</insert>

26823

<dialog title="Insert vpopmail_add_alias_domain_ex">vpopmail_add_alias_domain_ex(%0, %1);</dialog>

26824

26825

</function>

26826

26827

<description>Add an alias for a virtual domain</description>

26828

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26829

<param name="aliasdomain" required="1" vallist="0" default="" type="string">aliasdomain</param>

26830

26831

<insert>vpopmail_add_alias_domain(string domain, string aliasdomain);</insert>

26832

<dialog title="Insert vpopmail_add_alias_domain">vpopmail_add_alias_domain(%0, %1);</dialog>

26833

26834

</function>

26835

26836

<description>Add a new virtual domain</description>

26837

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26838

<param name="passwd" required="1" vallist="0" default="" type="string">passwd</param>

26839

<param name="quota" required="0" vallist="0" default="" type="string">quota</param>

26840

<param name="bounce" required="0" vallist="0" default="" type="string">bounce</param>

26841

26842

26843

<insert>vpopmail_add_domain_ex(string domain, string passwd [,string quota] [,string bounce] [,bool apop]);</insert>

26844

<dialog title="Insert vpopmail_add_domain_ex">vpopmail_add_domain_ex(%0, %1, %2, %3, %4);</dialog>

26845

26846

</function>

26847

26848

<description>Add a new virtual domain</description>

26849

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26850

26851

26852

26853

26854

<insert>vpopmail_add_domain(string domain, string dir, int uid, int gid);</insert>

26855

<dialog title="Insert vpopmail_add_domain">vpopmail_add_domain(%0, %1, %2, %3);</dialog>

26856

26857

</function>

26858

26859

<description>Add a new user to the specified virtual domain</description>

26860

26861

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26862

<param name="password" required="1" vallist="0" default="" type="string">password</param>

26863

<param name="gecos" required="0" vallist="0" default="" type="string">gecos</param>

26864

26865

26866

<insert>vpopmail_add_user(string user, string domain, string password [,string gecos] [,bool apop]);</insert>

26867

<dialog title="Insert vpopmail_add_user">vpopmail_add_user(%0, %1, %2, %3, %4);</dialog>

26868

26869

</function>

26870

26871

<description>insert a virtual alias</description>

26872

26873

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26874

<param name="alias" required="1" vallist="0" default="" type="string">alias</param>

26875

26876

<insert>vpopmail_alias_add(string user, string domain, string alias);</insert>

26877

<dialog title="Insert vpopmail_alias_add">vpopmail_alias_add(%0, %1, %2);</dialog>

26878

26879

</function>

26880

26881

<description>deletes all virtual aliases of a domain</description>

26882

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26883

26884

<insert>vpopmail_alias_del_domain(string domain);</insert>

26885

<dialog title="Insert vpopmail_alias_del_domain">vpopmail_alias_del_domain(%0);</dialog>

26886

26887

</function>

26888

26889

<description>deletes all virtual aliases of a user</description>

26890

26891

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26892

26893

<insert>vpopmail_alias_del(string user, string domain);</insert>

26894

<dialog title="Insert vpopmail_alias_del">vpopmail_alias_del(%0, %1);</dialog>

26895

26896

</function>

26897

26898

<description>get all lines of an alias for a domain</description>

26899

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26900

<return type="array">array</return>

26901

<insert>vpopmail_alias_get_all(string domain);</insert>

26902

<dialog title="Insert vpopmail_alias_get_all">vpopmail_alias_get_all(%0);</dialog>

26903

26904

</function>

26905

26906

<description>get all lines of an alias for a domain</description>

26907

<param name="alias" required="1" vallist="0" default="" type="string">alias</param>

26908

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26909

<return type="array">array</return>

26910

<insert>vpopmail_alias_get(string alias, string domain);</insert>

26911

<dialog title="Insert vpopmail_alias_get">vpopmail_alias_get(%0, %1);</dialog>

26912

26913

</function>

26914

26915

<description>Attempt to validate a username/domain/password. Returns true/false</description>

26916

26917

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26918

<param name="password" required="1" vallist="0" default="" type="string">password</param>

26919

26920

26921

<insert>vpopmail_auth_user(string user, string domain, string password [,string apop]);</insert>

26922

<dialog title="Insert vpopmail_auth_user">vpopmail_auth_user(%0, %1, %2, %3);</dialog>

26923

26924

</function>

26925

26926

<description>Delete a virtual domain</description>

26927

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26928

26929

<insert>vpopmail_del_domain_ex(string domain);</insert>

26930

<dialog title="Insert vpopmail_del_domain_ex">vpopmail_del_domain_ex(%0);</dialog>

26931

26932

</function>

26933

26934

<description>Delete a virtual domain</description>

26935

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26936

26937

<insert>vpopmail_del_domain(string domain);</insert>

26938

<dialog title="Insert vpopmail_del_domain">vpopmail_del_domain(%0);</dialog>

26939

26940

</function>

26941

26942

<description>Delete a user from a virtual domain</description>

26943

26944

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26945

26946

<insert>vpopmail_del_user(string user, string domain);</insert>

26947

<dialog title="Insert vpopmail_del_user">vpopmail_del_user(%0, %1);</dialog>

26948

26949

</function>

26950

26951

<description>Get text message for last vpopmail error. Returns string</description>

26952

<return type="string">string</return>

26953

<insert>vpopmail_error();</insert>

26954

<dialog title="Insert vpopmail_error">vpopmail_error();</dialog>

26955

26956

</function>

26957

26958

<description>Change a virtual user's password</description>

26959

26960

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26961

<param name="password" required="1" vallist="0" default="" type="string">password</param>

26962

26963

<insert>vpopmail_passwd(string user, string domain, string password);</insert>

26964

<dialog title="Insert vpopmail_passwd">vpopmail_passwd(%0, %1, %2);</dialog>

26965

26966

</function>

26967

26968

<description>Sets a virtual user's quota</description>

26969

26970

<param name="domain" required="1" vallist="0" default="" type="string">domain</param>

26971

<param name="quota" required="1" vallist="0" default="" type="string">quota</param>

26972

26973

<insert>vpopmail_set_user_quota(string user, string domain, string quota);</insert>

26974

<dialog title="Insert vpopmail_set_user_quota">vpopmail_set_user_quota(%0, %1, %2);</dialog>

26975

26976

</function>

26977

</group>

26978

26979

26980

<description>Defines a type for use with other w32api_functions</description>

26981

<param name="typename" required="1" vallist="0" default="" type="string">typename</param>

26982

<param name="member1_type" required="1" vallist="0" default="" type="string">member1_type</param>

26983

<param name="member1_name" required="1" vallist="0" default="" type="string">member1_name</param>

26984

26985

26986

26987

<insert>w32api_deftype(string typename, string member1_type, string member1_name [,string ...] [,string ...]);</insert>

26988

<dialog title="Insert w32api_deftype">w32api_deftype(%0, %1, %2, %3, %4);</dialog>

26989

26990

</function>

26991

26992

26993

Creates an instance of the data type typename and fills it with the values passed

26994

</description>

26995

<param name="typename" required="1" vallist="0" default="" type="string">typename</param>

26996

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

26997

26998

<return type="resource">resource</return>

26999

<insert>w32api_init_dtype(string typename, mixed value [,mixed ...]);</insert>

27000

<dialog title="Insert w32api_init_dtype">w32api_init_dtype(%0, %1, %2);</dialog>

27001

27002

</function>

27003

27004

<description>Invokes function funcname with the arguments passed after the function name</description>

27005

<param name="funcname" required="1" vallist="0" default="" type="string">funcname</param>

27006

<param name="argument" required="1" vallist="0" default="" type="mixed">argument</param>

27007

27008

<return type="mixed">mixed</return>

27009

<insert>w32api_invoke_function(string funcname, mixed argument [,mixed ...]);</insert>

27010

<dialog title="Insert w32api_invoke_function">w32api_invoke_function(%0, %1, %2);</dialog>

27011

27012

</function>

27013

27014

<description>Registers function function_name from library with PHP</description>

27015

<param name="libary" required="1" vallist="0" default="" type="string">libary</param>

27016

<param name="function_name" required="1" vallist="0" default="" type="string">function_name</param>

27017

<param name="return_type" required="1" vallist="0" default="" type="string">return_type</param>

27018

27019

<insert>w32api_register_function(string libary, string function_name, string return_type);</insert>

27020

<dialog title="Insert w32api_register_function">w32api_register_function(%0, %1, %2);</dialog>

27021

27022

</function>

27023

27024

<description>Sets the calling method used</description>

27025

<param name="method" required="1" vallist="0" default="" type="int">method</param>

27026

27027

<insert>w32api_set_call_method(int method);</insert>

27028

<dialog title="Insert w32api_set_call_method">w32api_set_call_method(%0);</dialog>

27029

27030

</function>

27031

</group>

27032

27033

27034

27035

Add variables to a WDDX packet with the specified ID

27036

</description>

27037

<param name="packet_id" required="1" vallist="0" default="" type="int">packet_id</param>

27038

27039

27040

27041

<insert>wddx_add_vars(int packet_id, mixed name_var [,mixed ...]);</insert>

27042

27043

27044

</function>

27045

27046

<description>Deserializes a WDDX packet</description>

27047

<param name="packet" required="1" vallist="0" default="" type="string">packet</param>

27048

<return type="mixed">mixed</return>

27049

<insert>wddx_deserialize(string packet);</insert>

27050

<dialog title="Insert wddx_deserialize">wddx_deserialize(%0);</dialog>

27051

27052

</function>

27053

27054

<description>Ends a WDDX packet with the specified ID</description>

27055

<param name="packet_id" required="1" vallist="0" default="" type="int">packet_id</param>

27056

<return type="string">string</return>

27057

<insert>wddx_packet_end(int packet_id);</insert>

27058

<dialog title="Insert wddx_packet_end">wddx_packet_end(%0);</dialog>

27059

27060

</function>

27061

27062

27063

Starts a new WDDX packet with structure inside it

27064

</description>

27065

<param name="comment" required="0" vallist="0" default="" type="string">comment</param>

27066

27067

<insert>wddx_packet_start([string comment]);</insert>

27068

<dialog title="Insert wddx_packet_start">wddx_packet_start(%0);</dialog>

27069

27070

</function>

27071

27072

<description>Serialize a single value into a WDDX packet</description>

27073

27074

<param name="comment" required="0" vallist="0" default="" type="string">comment</param>

27075

<return type="string">string</return>

27076

<insert>wddx_serialize_value(mixed var [,string comment]);</insert>

27077

<dialog title="Insert wddx_serialize_value">wddx_serialize_value(%0, %1);</dialog>

27078

27079

</function>

27080

27081

<description>Serialize variables into a WDDX packet</description>

27082

27083

27084

<return type="string">string</return>

27085

<insert>wddx_serialize_vars(mixed var_name [,mixed ...]);</insert>

27086

<dialog title="Insert wddx_serialize_vars">wddx_serialize_vars(%0, %1);</dialog>

27087

27088

</function>

27089

</group>

27090

27091

27092

27093

Converts a string with ISO-8859-1 characters encoded with UTF-8

27094

to single-byte ISO-8859-1.

27095

</description>

27096

27097

<return type="string">string</return>

27098

<insert>utf8_decode(string data);</insert>

27099

<dialog title="Insert utf8_decode">utf8_decode(%0);</dialog>

27100

27101

</function>

27102

27103

<description>encodes an ISO-8859-1 string to UTF-8</description>

27104

27105

<return type="string">string</return>

27106

<insert>utf8_encode(string data);</insert>

27107

<dialog title="Insert utf8_encode">utf8_encode(%0);</dialog>

27108

27109

</function>

27110

27111

<description>get XML parser error string</description>

27112

27113

<return type="string">string</return>

27114

<insert>xml_error_string(int code);</insert>

27115

<dialog title="Insert xml_error_string">xml_error_string(%0);</dialog>

27116

27117

</function>

27118

27119

<description>get current byte index for an XML parser</description>

27120

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27121

27122

<insert>xml_get_current_byte_index(resource parser);</insert>

27123

<dialog title="Insert xml_get_current_byte_index">xml_get_current_byte_index(%0);</dialog>

27124

27125

</function>

27126

27127

27128

Get current column number for an XML parser

27129

</description>

27130

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27131

27132

<insert>xml_get_current_column_number(resource parser);</insert>

27133

<dialog title="Insert xml_get_current_column_number">xml_get_current_column_number(%0);</dialog>

27134

27135

</function>

27136

27137

<description>get current line number for an XML parser</description>

27138

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27139

27140

<insert>xml_get_current_line_number(resource parser);</insert>

27141

<dialog title="Insert xml_get_current_line_number">xml_get_current_line_number(%0);</dialog>

27142

27143

</function>

27144

27145

<description>get XML parser error code</description>

27146

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27147

27148

<insert>xml_get_error_code(resource parser);</insert>

27149

<dialog title="Insert xml_get_error_code">xml_get_error_code(%0);</dialog>

27150

27151

</function>

27152

27153

<description>Parse XML data into an array structure</description>

27154

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27155

27156

<param name="&values" required="1" vallist="0" default="" type="array">&values</param>

27157

<param name="&index" required="0" vallist="0" default="" type="array">&index</param>

27158

27159

<insert>xml_parse_into_struct(resource parser, string data, array &values [,array &index]);</insert>

27160

<dialog title="Insert xml_parse_into_struct">xml_parse_into_struct(%0, %1, %2, %3);</dialog>

27161

27162

</function>

27163

27164

<description>start parsing an XML document</description>

27165

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27166

27167

<param name="is_final" required="0" vallist="0" default="" type="bool">is_final</param>

27168

27169

<insert>xml_parse(resource parser, string data [,bool is_final]);</insert>

27170

<dialog title="Insert xml_parse">xml_parse(%0, %1, %2);</dialog>

27171

27172

</function>

27173

27174

27175

Create an XML parser

27176

</description>

27177

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

27178

<param name="separator" required="0" vallist="0" default="" type="string">separator</param>

27179

<return type="resource">resource</return>

27180

<insert>xml_parser_create_ns([string encoding] [,string separator]);</insert>

27181

<dialog title="Insert xml_parser_create_ns">xml_parser_create_ns(%0, %1);</dialog>

27182

27183

</function>

27184

27185

<description>create an XML parser</description>

27186

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

27187

<return type="resource">resource</return>

27188

<insert>xml_parser_create([string encoding]);</insert>

27189

<dialog title="Insert xml_parser_create">xml_parser_create(%0);</dialog>

27190

27191

</function>

27192

27193

<description>Free an XML parser</description>

27194

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27195

27196

<insert>xml_parser_free(resource parser);</insert>

27197

<dialog title="Insert xml_parser_free">xml_parser_free(%0);</dialog>

27198

27199

</function>

27200

27201

<description>get options from an XML parser</description>

27202

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27203

<param name="option" required="1" vallist="0" default="" type="int">option</param>

27204

<return type="mixed">mixed</return>

27205

<insert>xml_parser_get_option(resource parser, int option);</insert>

27206

<dialog title="Insert xml_parser_get_option">xml_parser_get_option(%0, %1);</dialog>

27207

27208

</function>

27209

27210

<description>set options in an XML parser</description>

27211

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27212

<param name="option" required="1" vallist="0" default="" type="int">option</param>

27213

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

27214

27215

<insert>xml_parser_set_option(resource parser, int option, mixed value);</insert>

27216

<dialog title="Insert xml_parser_set_option">xml_parser_set_option(%0, %1, %2);</dialog>

27217

27218

</function>

27219

27220

<description>set up character data handler</description>

27221

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27222

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27223

27224

<insert>xml_set_character_data_handler(resource parser, callback handler);</insert>

27225

<dialog title="Insert xml_set_character_data_handler">xml_set_character_data_handler(%0, %1);</dialog>

27226

27227

</function>

27228

27229

<description>set up default handler</description>

27230

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27231

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27232

27233

<insert>xml_set_default_handler(resource parser, callback handler);</insert>

27234

<dialog title="Insert xml_set_default_handler">xml_set_default_handler(%0, %1);</dialog>

27235

27236

</function>

27237

27238

<description>set up start and end element handlers</description>

27239

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27240

<param name="start_element_handler" required="1" vallist="0" default="" type="callback">start_element_handler</param>

27241

<param name="end_element_handler" required="1" vallist="0" default="" type="callback">end_element_handler</param>

27242

27243

<insert>xml_set_element_handler(resource parser, callback start_element_handler, callback end_element_handler);</insert>

27244

<dialog title="Insert xml_set_element_handler">xml_set_element_handler(%0, %1, %2);</dialog>

27245

27246

</function>

27247

27248

27249

Set up character data handler

27250

</description>

27251

27252

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27253

27254

<insert>xml_set_end_namespace_decl_handler(resource pind, callback handler);</insert>

27255

<dialog title="Insert xml_set_end_namespace_decl_handler">xml_set_end_namespace_decl_handler(%0, %1);</dialog>

27256

27257

</function>

27258

27259

<description>set up external entity reference handler</description>

27260

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27261

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27262

27263

<insert>xml_set_external_entity_ref_handler(resource parser, callback handler);</insert>

27264

<dialog title="Insert xml_set_external_entity_ref_handler">xml_set_external_entity_ref_handler(%0, %1);</dialog>

27265

27266

</function>

27267

27268

<description>set up notation declaration handler</description>

27269

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27270

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27271

27272

<insert>xml_set_notation_decl_handler(resource parser, callback handler);</insert>

27273

<dialog title="Insert xml_set_notation_decl_handler">xml_set_notation_decl_handler(%0, %1);</dialog>

27274

27275

</function>

27276

27277

<description>Use XML Parser within an object</description>

27278

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27279

<param name="object" required="1" vallist="0" default="" type="object">object</param>

27280

27281

<insert>xml_set_object(resource parser, object object);</insert>

27282

<dialog title="Insert xml_set_object">xml_set_object(%0, %1);</dialog>

27283

27284

</function>

27285

27286

27287

Set up processing instruction (PI) handler

27288

</description>

27289

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27290

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27291

27292

<insert>xml_set_processing_instruction_handler(resource parser, callback handler);</insert>

27293

<dialog title="Insert xml_set_processing_instruction_handler">xml_set_processing_instruction_handler(%0, %1);</dialog>

27294

27295

</function>

27296

27297

27298

Set up character data handler

27299

</description>

27300

27301

27302

27303

<insert>xml_set_start_namespace_decl_handler(resource pind, callback hdl);</insert>

27304

<dialog title="Insert xml_set_start_namespace_decl_handler">xml_set_start_namespace_decl_handler(%0, %1);</dialog>

27305

27306

</function>

27307

27308

27309

Set up unparsed entity declaration handler

27310

</description>

27311

<param name="parser" required="1" vallist="0" default="" type="resource">parser</param>

27312

<param name="handler" required="1" vallist="0" default="" type="callback">handler</param>

27313

27314

<insert>xml_set_unparsed_entity_decl_handler(resource parser, callback handler);</insert>

27315

<dialog title="Insert xml_set_unparsed_entity_decl_handler">xml_set_unparsed_entity_decl_handler(%0, %1);</dialog>

27316

27317

</function>

27318

</group>

27319

27320

27321

<description>Decodes XML into native PHP types</description>

27322

27323

<param name="method" required="1" vallist="0" default="" type="string">method</param>

27324

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

27325

<return type="array">array</return>

27326

<insert>xmlrpc_decode_request(string xml, string method [,string encoding]);</insert>

27327

<dialog title="Insert xmlrpc_decode_request">xmlrpc_decode_request(%0, %1, %2);</dialog>

27328

27329

</function>

27330

27331

<description>Decodes XML into native PHP types</description>

27332

27333

<param name="encoding" required="0" vallist="0" default="" type="string">encoding</param>

27334

<return type="array">array</return>

27335

<insert>xmlrpc_decode(string xml [,string encoding]);</insert>

27336

<dialog title="Insert xmlrpc_decode">xmlrpc_decode(%0, %1);</dialog>

27337

27338

</function>

27339

27340

<description>Generates XML for a method request</description>

27341

<param name="method" required="1" vallist="0" default="" type="string">method</param>

27342

<param name="params" required="1" vallist="0" default="" type="mixed">params</param>

27343

<return type="string">string</return>

27344

<insert>xmlrpc_encode_request(string method, mixed params);</insert>

27345

<dialog title="Insert xmlrpc_encode_request">xmlrpc_encode_request(%0, %1);</dialog>

27346

27347

</function>

27348

27349

<description>Generates XML for a PHP value</description>

27350

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

27351

<return type="string">string</return>

27352

<insert>xmlrpc_encode(mixed value);</insert>

27353

<dialog title="Insert xmlrpc_encode">xmlrpc_encode(%0);</dialog>

27354

27355

</function>

27356

27357

<description>Gets xmlrpc type for a PHP value. Especially useful for base64 and datetime strings</description>

27358

<param name="value" required="1" vallist="0" default="" type="mixed">value</param>

27359

<return type="string">string</return>

27360

<insert>xmlrpc_get_type(mixed value);</insert>

27361

<dialog title="Insert xmlrpc_get_type">xmlrpc_get_type(%0);</dialog>

27362

27363

</function>

27364

27365

<description>Decodes XML into a list of method descriptions</description>

27366

27367

<return type="array">array</return>

27368

<insert>xmlrpc_parse_method_descriptions(string xml);</insert>

27369

<dialog title="Insert xmlrpc_parse_method_descriptions">xmlrpc_parse_method_descriptions(%0);</dialog>

27370

27371

</function>

27372

27373

<description>Adds introspection documentation</description>

27374

<param name="server" required="1" vallist="0" default="" type="resource">server</param>

27375

27376

27377

<insert>xmlrpc_server_add_introspection_data(resource server, array desc);</insert>

27378

<dialog title="Insert xmlrpc_server_add_introspection_data">xmlrpc_server_add_introspection_data(%0, %1);</dialog>

27379

27380

</function>

27381

27382

<description>Parses XML requests and call methods</description>

27383

<param name="server" required="1" vallist="0" default="" type="resource">server</param>

27384

27385

27386

<param name="output_options" required="0" vallist="0" default="" type="array">output_options</param>

27387

<return type="mixed">mixed</return>

27388

<insert>xmlrpc_server_call_method(resource server, string xml, mixed user_data [,array output_options]);</insert>

27389

<dialog title="Insert xmlrpc_server_call_method">xmlrpc_server_call_method(%0, %1, %2, %3);</dialog>

27390

27391

</function>

27392

27393

<description>Creates an xmlrpc server</description>

27394

<return type="resource">resource</return>

27395

<insert>xmlrpc_server_create();</insert>

27396

<dialog title="Insert xmlrpc_server_create">xmlrpc_server_create();</dialog>

27397

27398

</function>

27399

27400

<description>Destroys server resources</description>

27401

<param name="server" required="1" vallist="0" default="" type="resource">server</param>

27402

27403

<insert>xmlrpc_server_destroy(resource server);</insert>

27404

<dialog title="Insert xmlrpc_server_destroy">xmlrpc_server_destroy(%0);</dialog>

27405

27406

</function>

27407

27408

<description>Register a PHP function to generate documentation</description>

27409

<param name="server" required="1" vallist="0" default="" type="resource">server</param>

27410

<param name="function" required="1" vallist="0" default="" type="string">function</param>

27411

27412

<insert>xmlrpc_server_register_introspection_callback(resource server, string function);</insert>

27413

<dialog title="Insert xmlrpc_server_register_introspection_callback">xmlrpc_server_register_introspection_callback(%0, %1);</dialog>

27414

27415

</function>

27416

27417

<description>Register a PHP function to resource method matching method_name</description>

27418

<param name="server" required="1" vallist="0" default="" type="resource">server</param>

27419

<param name="method_name" required="1" vallist="0" default="" type="string">method_name</param>

27420

<param name="function" required="1" vallist="0" default="" type="string">function</param>

27421

27422

<insert>xmlrpc_server_register_method(resource server, string method_name, string function);</insert>

27423

<dialog title="Insert xmlrpc_server_register_method">xmlrpc_server_register_method(%0, %1, %2);</dialog>

27424

27425

</function>

27426

27427

<description>Sets xmlrpc type, base64 or datetime, for a PHP string value</description>

27428

<param name="value" required="1" vallist="0" default="" type="string">value</param>

27429

27430

27431

<insert>xmlrpc_set_type(string value, string type);</insert>

27432

<dialog title="Insert xmlrpc_set_type">xmlrpc_set_type(%0, %1);</dialog>

27433

27434

</function>

27435

</group>

27436

27437

27438

<description>Create a new XSLT processor</description>

27439

<return type="resource">resource</return>

27440

<insert>xslt_create();</insert>

27441

<dialog title="Insert xslt_create">xslt_create();</dialog>

27442

27443

</function>

27444

27445

<description>Return a error number</description>

27446

27447

27448

<insert>xslt_errno(resource xh);</insert>

27449

<dialog title="Insert xslt_errno">xslt_errno(%0);</dialog>

27450

27451

</function>

27452

27453

<description>Return a error string</description>

27454

27455

<return type="mixed">mixed</return>

27456

<insert>xslt_error(resource xh);</insert>

27457

<dialog title="Insert xslt_error">xslt_error(%0);</dialog>

27458

27459

</function>

27460

27461

<description>Free XSLT processor</description>

27462

27463

27464

<insert>xslt_free(resource xh);</insert>

27465

27466

27467

</function>

27468

27469

<description>Perform an XSLT transformation</description>

27470

27471

<param name="xmlcontainer" required="1" vallist="0" default="" type="string">xmlcontainer</param>

27472

<param name="xslcontainer" required="1" vallist="0" default="" type="string">xslcontainer</param>

27473

<param name="resultcontainer" required="0" vallist="0" default="" type="string">resultcontainer</param>

27474

<param name="arguments" required="0" vallist="0" default="" type="array">arguments</param>

27475

<param name="parameters" required="0" vallist="0" default="" type="array">parameters</param>

27476

<return type="mixed">mixed</return>

27477

<insert>xslt_process(resource xh, string xmlcontainer, string xslcontainer [,string resultcontainer] [,array arguments] [,array parameters]);</insert>

27478

<dialog title="Insert xslt_process">xslt_process(%0, %1, %2, %3, %4, %5);</dialog>

27479

27480

</function>

27481

27482

<description>Set the base URI for all XSLT transformations</description>

27483

27484

27485

27486

<insert>xslt_set_base(resource xh, string uri);</insert>

27487

27488

27489

</function>

27490

27491

<description>Set the encoding for the parsing of XML documents</description>

27492

27493

<param name="encoding" required="1" vallist="0" default="" type="string">encoding</param>

27494

27495

<insert>xslt_set_encoding(resource xh, string encoding);</insert>

27496

<dialog title="Insert xslt_set_encoding">xslt_set_encoding(%0, %1);</dialog>

27497

27498

</function>

27499

27500

<description>Set an error handler for a XSLT processor</description>

27501

27502

<param name="handler" required="1" vallist="0" default="" type="mixed">handler</param>

27503

27504

<insert>xslt_set_error_handler(resource xh, mixed handler);</insert>

27505

<dialog title="Insert xslt_set_error_handler">xslt_set_error_handler(%0, %1);</dialog>

27506

27507

</function>

27508

27509

<description>Set the log file to write log messages to</description>

27510

27511

27512

27513

<insert>xslt_set_log(resource xh, mixed log);</insert>

27514

27515

27516

</function>

27517

27518

<description>Set SAX handlers for a XSLT processor</description>

27519

27520

<param name="handlers" required="1" vallist="0" default="" type="array">handlers</param>

27521

27522

<insert>xslt_set_sax_handler(resource xh, array handlers);</insert>

27523

<dialog title="Insert xslt_set_sax_handler">xslt_set_sax_handler(%0, %1);</dialog>

27524

27525

</function>

27526

27527

27528

Set the SAX handlers to be called when the XML document gets processed

27529

</description>

27530

<param name="processor" required="1" vallist="0" default="" type="resource">processor</param>

27531

<param name="handlers" required="1" vallist="0" default="" type="array">handlers</param>

27532

27533

<insert>xslt_set_sax_handlers(resource processor, array handlers);</insert>

27534

<dialog title="Insert xslt_set_sax_handlers">xslt_set_sax_handlers(%0, %1);</dialog>

27535

27536

</function>

27537

27538

<description>Set Scheme handlers for a XSLT processor</description>

27539

27540

<param name="handlers" required="1" vallist="0" default="" type="array">handlers</param>

27541

27542

<insert>xslt_set_scheme_handler(resource xh, array handlers);</insert>

27543

<dialog title="Insert xslt_set_scheme_handler">xslt_set_scheme_handler(%0, %1);</dialog>

27544

27545

</function>

27546

27547

27548

Set the scheme handlers for the XSLT processor

27549

</description>

27550

<param name="processor" required="1" vallist="0" default="" type="resource">processor</param>

27551

<param name="handlers" required="1" vallist="0" default="" type="array">handlers</param>

27552

27553

<insert>xslt_set_scheme_handlers(resource processor, array handlers);</insert>

27554

<dialog title="Insert xslt_set_scheme_handlers">xslt_set_scheme_handlers(%0, %1);</dialog>

27555

27556

</function>

27557

</group>

27558

27559

27560

<description>Returns additional error information</description>

27561

27562

<return type="string">string</return>

27563

<insert>yaz_addinfo(resource id);</insert>

27564

<dialog title="Insert yaz_addinfo">yaz_addinfo(%0);</dialog>

27565

27566

</function>

27567

27568

<description>Configure CCL parser</description>

27569

27570

<param name="config" required="1" vallist="0" default="" type="array">config</param>

27571

27572

<insert>yaz_ccl_conf(resource id, array config);</insert>

27573

27574

27575

</function>

27576

27577

<description>Invoke CCL Parser</description>

27578

27579

<param name="query" required="1" vallist="0" default="" type="string">query</param>

27580

<param name="result" required="1" vallist="0" default="" type="array &">result</param>

27581

27582

<insert>yaz_ccl_parse(resource id, string query, array & result);</insert>

27583

<dialog title="Insert yaz_ccl_parse">yaz_ccl_parse(%0, %1, %2);</dialog>

27584

27585

</function>

27586

27587

<description>Close YAZ connection</description>

27588

27589

27590

<insert>yaz_close(resource id);</insert>

27591

<dialog title="Insert yaz_close">yaz_close(%0);</dialog>

27592

27593

</function>

27594

27595

27596

Prepares for a connection to a Z39.50 target (server).

27597

</description>

27598

27599

<param name="options" required="0" vallist="0" default="" type="mixed">options</param>

27600

<return type="resource">resource</return>

27601

<insert>yaz_connect(string zurl [,mixed options]);</insert>

27602

<dialog title="Insert yaz_connect">yaz_connect(%0, %1);</dialog>

27603

27604

</function>

27605

27606

27607

Specifies the databases within a session

27608

</description>

27609

27610

<param name="databases" required="1" vallist="0" default="" type="string">databases</param>

27611

27612

<insert>yaz_database(resource id, string databases);</insert>

27613

<dialog title="Insert yaz_database">yaz_database(%0, %1);</dialog>

27614

27615

</function>

27616

27617

27618

Specifies Element-Set Name for retrieval

27619

</description>

27620

27621

<param name="elementset" required="1" vallist="0" default="" type="string">elementset</param>

27622

27623

<insert>yaz_element(resource id, string elementset);</insert>

27624

<dialog title="Insert yaz_element">yaz_element(%0, %1);</dialog>

27625

27626

</function>

27627

27628

<description>Returns error number</description>

27629

27630

27631

<insert>yaz_errno(resource id);</insert>

27632

<dialog title="Insert yaz_errno">yaz_errno(%0);</dialog>

27633

27634

</function>

27635

27636

<description>Returns error description</description>

27637

27638

<return type="string">string</return>

27639

<insert>yaz_error(resource id);</insert>

27640

<dialog title="Insert yaz_error">yaz_error(%0);</dialog>

27641

27642

</function>

27643

27644

<description>Returns value of option for connection</description>

27645

27646

27647

<return type="string">string</return>

27648

<insert>yaz_get_option(resource id, string name);</insert>

27649

<dialog title="Insert yaz_get_option">yaz_get_option(%0, %1);</dialog>

27650

27651

</function>

27652

27653

<description>Returns number of hits for last search</description>

27654

27655

27656

<insert>yaz_hits(resource id);</insert>

27657

27658

27659

</function>

27660

27661

27662

Prepares for Z39.50 Item Order with an ILL-Request package

27663

</description>

27664

27665

27666

27667

<insert>yaz_itemorder(resource id, array args);</insert>

27668

<dialog title="Insert yaz_itemorder">yaz_itemorder(%0, %1);</dialog>

27669

27670

</function>

27671

27672

27673

Prepares for retrieval (Z39.50 present).

27674

</description>

27675

27676

27677

<insert>yaz_present(resource id);</insert>

27678

<dialog title="Insert yaz_present">yaz_present(%0);</dialog>

27679

27680

</function>

27681

27682

27683

Specifies the maximum number of records to retrieve

27684

</description>

27685

27686

<param name="start" required="1" vallist="0" default="" type="int">start</param>

27687

<param name="number" required="1" vallist="0" default="" type="int">number</param>

27688

27689

<insert>yaz_range(resource id, int start, int number);</insert>

27690

<dialog title="Insert yaz_range">yaz_range(%0, %1, %2);</dialog>

27691

27692

</function>

27693

27694

<description>Returns a record</description>

27695

27696

27697

27698

<return type="string">string</return>

27699

<insert>yaz_record(resource id, int pos, string type);</insert>

27700

<dialog title="Insert yaz_record">yaz_record(%0, %1, %2);</dialog>

27701

27702

</function>

27703

27704

<description>Returns Scan Response result</description>

27705

27706

<param name="result" required="0" vallist="0" default="" type="array">result</param>

27707

<return type="array">array</return>

27708

<insert>yaz_scan_result(resource id [,array result]);</insert>

27709

<dialog title="Insert yaz_scan_result">yaz_scan_result(%0, %1);</dialog>

27710

27711

</function>

27712

27713

<description>Prepares for a scan</description>

27714

27715

27716

<param name="startterm" required="1" vallist="0" default="" type="string">startterm</param>

27717

<param name="flags" required="0" vallist="0" default="" type="array">flags</param>

27718

27719

<insert>yaz_scan(resource id, string type, string startterm [,array flags]);</insert>

27720

27721

27722

</function>

27723

27724

27725

Specifies schema for retrieval.

27726

</description>

27727

27728

<param name="schema" required="1" vallist="0" default="" type="string">schema</param>

27729

27730

<insert>yaz_schema(resource id, string schema);</insert>

27731

<dialog title="Insert yaz_schema">yaz_schema(%0, %1);</dialog>

27732

27733

</function>

27734

27735

<description>Prepares for a search</description>

27736

27737

27738

<param name="query" required="1" vallist="0" default="" type="string">query</param>

27739

27740

<insert>yaz_search(resource id, string type, string query);</insert>

27741

<dialog title="Insert yaz_search">yaz_search(%0, %1, %2);</dialog>

27742

27743

</function>

27744

27745

<description>Sets one or more options for connection</description>

27746

27747

27748

<param name="value" required="1" vallist="0" default="" type="string">value</param>

27749

<return type="string">string</return>

27750

<insert>yaz_set_option(resource id, string name, string value);</insert>

27751

<dialog title="Insert yaz_set_option">yaz_set_option(%0, %1, %2);</dialog>

27752

27753

</function>

27754

27755

<description>Sets sorting criteria</description>

27756

27757

<param name="criteria" required="1" vallist="0" default="" type="string">criteria</param>

27758

27759

<insert>yaz_sort(resource id, string criteria);</insert>

27760

27761

27762

</function>

27763

27764

27765

Specifies the preferred record syntax for retrieval.

27766

</description>

27767

27768

<param name="syntax" required="1" vallist="0" default="" type="string">syntax</param>

27769

27770

<insert>yaz_syntax(resource id, string syntax);</insert>

27771

<dialog title="Insert yaz_syntax">yaz_syntax(%0, %1);</dialog>

27772

27773

</function>

27774

27775

<description>Wait for Z39.50 requests to complete</description>

27776

<param name="options" required="0" vallist="0" default="" type="array">options</param>

27777

27778

<insert>yaz_wait([array options]);</insert>

27779

27780

27781

</function>

27782

</group>

27783

27784

27785

<description>Close a Zip File Archive</description>

27786

27787

27788

<insert>zip_close(resource zip);</insert>

27789

<dialog title="Insert zip_close">zip_close(%0);</dialog>

27790

27791

</function>

27792

27793

<description>Close a Directory Entry</description>

27794

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27795

27796

<insert>zip_entry_close(resource zip_entry);</insert>

27797

<dialog title="Insert zip_entry_close">zip_entry_close(%0);</dialog>

27798

27799

</function>

27800

27801

<description>Retrieve the Compressed Size of a Directory Entry</description>

27802

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27803

27804

<insert>zip_entry_compressedsize(resource zip_entry);</insert>

27805

<dialog title="Insert zip_entry_compressedsize">zip_entry_compressedsize(%0);</dialog>

27806

27807

</function>

27808

27809

<description>Retrieve the Compression Method of a Directory Entry</description>

27810

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27811

<return type="string">string</return>

27812

<insert>zip_entry_compressionmethod(resource zip_entry);</insert>

27813

<dialog title="Insert zip_entry_compressionmethod">zip_entry_compressionmethod(%0);</dialog>

27814

27815

</function>

27816

27817

<description>Retrieve the Actual File Size of a Directory Entry</description>

27818

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27819

27820

<insert>zip_entry_filesize(resource zip_entry);</insert>

27821

<dialog title="Insert zip_entry_filesize">zip_entry_filesize(%0);</dialog>

27822

27823

</function>

27824

27825

<description>Retrieve the Name of a Directory Entry</description>

27826

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27827

<return type="string">string</return>

27828

<insert>zip_entry_name(resource zip_entry);</insert>

27829

<dialog title="Insert zip_entry_name">zip_entry_name(%0);</dialog>

27830

27831

</function>

27832

27833

<description>Open a Directory Entry for Reading</description>

27834

27835

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27836

27837

27838

<insert>zip_entry_open(resource zip, resource zip_entry [,string mode]);</insert>

27839

<dialog title="Insert zip_entry_open">zip_entry_open(%0, %1, %2);</dialog>

27840

27841

</function>

27842

27843

<description>Read From an Open Directory Entry</description>

27844

<param name="zip_entry" required="1" vallist="0" default="" type="resource">zip_entry</param>

27845

<param name="length" required="0" vallist="0" default="" type="int">length</param>

27846

<return type="string">string</return>

27847

<insert>zip_entry_read(resource zip_entry [,int length]);</insert>

27848

<dialog title="Insert zip_entry_read">zip_entry_read(%0, %1);</dialog>

27849

27850

</function>

27851

27852

<description>Open a Zip File Archive</description>

27853

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

27854

<return type="resource">resource</return>

27855

<insert>zip_open(string filename);</insert>

27856

27857

27858

</function>

27859

27860

<description>Read Next Entry in a Zip File Archive</description>

27861

27862

<return type="resource">resource</return>

27863

<insert>zip_read(resource zip);</insert>

27864

27865

27866

</function>

27867

</group>

27868

27869

27870

<description>Close an open gz-file pointer</description>

27871

27872

27873

<insert>gzclose(resource zp);</insert>

27874

<dialog title="Insert gzclose">gzclose(%0);</dialog>

27875

27876

</function>

27877

27878

<description>Compress a string</description>

27879

27880

<param name="level" required="0" vallist="0" default="" type="int">level</param>

27881

<return type="string">string</return>

27882

<insert>gzcompress(string data [,int level]);</insert>

27883

<dialog title="Insert gzcompress">gzcompress(%0, %1);</dialog>

27884

27885

</function>

27886

27887

<description>Deflate a string</description>

27888

27889

<param name="level" required="0" vallist="0" default="" type="int">level</param>

27890

<return type="string">string</return>

27891

<insert>gzdeflate(string data [,int level]);</insert>

27892

<dialog title="Insert gzdeflate">gzdeflate(%0, %1);</dialog>

27893

27894

</function>

27895

27896

<description>Create a gzip compressed string</description>

27897

27898

<param name="level" required="0" vallist="0" default="" type="int">level</param>

27899

<param name="encoding_mode" required="0" vallist="0" default="" type="int">encoding_mode</param>

27900

<return type="string">string</return>

27901

<insert>gzencode(string data [,int level] [,int encoding_mode]);</insert>

27902

<dialog title="Insert gzencode">gzencode(%0, %1, %2);</dialog>

27903

27904

</function>

27905

27906

<description>Test for end-of-file on a gz-file pointer</description>

27907

27908

27909

<insert>gzeof(resource zp);</insert>

27910

<dialog title="Insert gzeof">gzeof(%0);</dialog>

27911

27912

</function>

27913

27914

<description>Read entire gz-file into an array</description>

27915

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

27916

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

27917

<return type="array">array</return>

27918

<insert>gzfile(string filename [,int use_include_path]);</insert>

27919

<dialog title="Insert gzfile">gzfile(%0, %1);</dialog>

27920

27921

</function>

27922

27923

<description>Get character from gz-file pointer</description>

27924

27925

<return type="string">string</return>

27926

<insert>gzgetc(resource zp);</insert>

27927

<dialog title="Insert gzgetc">gzgetc(%0);</dialog>

27928

27929

</function>

27930

27931

<description>Get line from file pointer</description>

27932

27933

<param name="length" required="1" vallist="0" default="" type="int">length</param>

27934

<return type="string">string</return>

27935

<insert>gzgets(resource zp, int length);</insert>

27936

<dialog title="Insert gzgets">gzgets(%0, %1);</dialog>

27937

27938

</function>

27939

27940

27941

Get line from gz-file pointer and strip HTML tags

27942

</description>

27943

27944

<param name="length" required="1" vallist="0" default="" type="int">length</param>

27945

<param name="allowable_tags" required="0" vallist="0" default="" type="string">allowable_tags</param>

27946

<return type="string">string</return>

27947

<insert>gzgetss(resource zp, int length [,string allowable_tags]);</insert>

27948

<dialog title="Insert gzgetss">gzgetss(%0, %1, %2);</dialog>

27949

27950

</function>

27951

27952

<description>Inflate a deflated string</description>

27953

27954

<param name="length" required="0" vallist="0" default="" type="int">length</param>

27955

<return type="string">string</return>

27956

<insert>gzinflate(string data [,int length]);</insert>

27957

<dialog title="Insert gzinflate">gzinflate(%0, %1);</dialog>

27958

27959

</function>

27960

27961

27962

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

27963

27964

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

27965

<return type="resource">resource</return>

27966

<insert>gzopen(string filename, string mode [,int use_include_path]);</insert>

27967

<dialog title="Insert gzopen">gzopen(%0, %1, %2);</dialog>

27968

27969

</function>

27970

27971

27972

Output all remaining data on a gz-file pointer

27973

</description>

27974

27975

27976

<insert>gzpassthru(resource zp);</insert>

27977

<dialog title="Insert gzpassthru">gzpassthru(%0);</dialog>

27978

27979

</function>

27980

27981

<description>Binary-safe gz-file read</description>

27982

27983

<param name="length" required="1" vallist="0" default="" type="int">length</param>

27984

<return type="string">string</return>

27985

<insert>gzread(resource zp, int length);</insert>

27986

<dialog title="Insert gzread">gzread(%0, %1);</dialog>

27987

27988

</function>

27989

27990

<description>Rewind the position of a gz-file pointer</description>

27991

27992

27993

<insert>gzrewind(resource zp);</insert>

27994

<dialog title="Insert gzrewind">gzrewind(%0);</dialog>

27995

27996

</function>

27997

27998

<description>Seek on a gz-file pointer</description>

27999

28000

<param name="offset" required="1" vallist="0" default="" type="int">offset</param>

28001

28002

<insert>gzseek(resource zp, int offset);</insert>

28003

<dialog title="Insert gzseek">gzseek(%0, %1);</dialog>

28004

28005

</function>

28006

28007

<description>Tell gz-file pointer read/write position</description>

28008

28009

28010

<insert>gztell(resource zp);</insert>

28011

<dialog title="Insert gztell">gztell(%0);</dialog>

28012

28013

</function>

28014

28015

<description>Uncompress a deflated string</description>

28016

28017

<param name="length" required="0" vallist="0" default="" type="int">length</param>

28018

<return type="string">string</return>

28019

<insert>gzuncompress(string data [,int length]);</insert>

28020

<dialog title="Insert gzuncompress">gzuncompress(%0, %1);</dialog>

28021

28022

</function>

28023

28024

<description>Binary-safe gz-file write</description>

28025

28026

<param name="string" required="1" vallist="0" default="" type="string">string</param>

28027

<param name="length" required="0" vallist="0" default="" type="int">length</param>

28028

28029

<insert>gzwrite(resource zp, string string [,int length]);</insert>

28030

<dialog title="Insert gzwrite">gzwrite(%0, %1, %2);</dialog>

28031

28032

</function>

28033

28034

<description>Output a gz-file</description>

28035

<param name="filename" required="1" vallist="0" default="" type="string">filename</param>

28036

<param name="use_include_path" required="0" vallist="0" default="" type="int">use_include_path</param>

28037

28038

<insert>readgzfile(string filename [,int use_include_path]);</insert>

28039

<dialog title="Insert readgzfile">readgzfile(%0, %1);</dialog>

28040

28041

</function>

28042

</group>