Liking cljdoc? Tell your friends :D

grammar.lang.php

PHP as a target language, as data in the shapes of grammar.realize and grammar.probe.

realizations :lit, :str and :write-file rendered in :php. Each one requires :php.fn/<f> for every PHP function its text calls, so a function removed with -d disable_functions=... takes the realizations that call it out of the search. Language constructs (echo, eval, exit) are not functions and cannot be disabled; they require nothing. wrappers context emitters into and out of PHP: sh running php -r, php eval, php running sh or python3 through proc_open, python running php through subprocess. probes :interp/php, :php/first-class-callable, :php/proc-open-argv, then one function_exists probe per function the realizations and wrappers call. Each needs :interp/php, so without php they are skipped and stay :unknown.

module bundles the three for grammar.core/compose, and grammar.core/modules includes it by default.

PHP as a target language, as data in the shapes of grammar.realize and
grammar.probe.

realizations  :lit, :str and :write-file rendered in :php. Each one
              requires :php.fn/<f> for every PHP function its text calls,
              so a function removed with `-d disable_functions=...` takes
              the realizations that call it out of the search. Language
              constructs (echo, eval, exit) are not functions and cannot
              be disabled; they require nothing.
wrappers      context emitters into and out of PHP: sh running php -r,
              php eval, php running sh or python3 through proc_open,
              python running php through subprocess.
probes        :interp/php, :php/first-class-callable, :php/proc-open-argv,
              then one function_exists probe per function the realizations
              and wrappers call. Each needs :interp/php, so without php
              they are skipped and stay :unknown.

`module` bundles the three for grammar.core/compose, and
grammar.core/modules includes it by default.
raw docstring

fn-capclj

(fn-cap f)

Capability naming PHP function f: :php.fn/<f>.

Capability naming PHP function f: :php.fn/<f>.
sourceraw docstring

functionsclj

Every PHP function the realizations and wrappers call, sorted.

Every PHP function the realizations and wrappers call, sorted.
sourceraw docstring

moduleclj

PHP as a grammar.core language module. Its parts are vars, so reloading this namespace is seen without reloading grammar.core. Its probes need :sh/single-quote, so it goes after the core module.

PHP as a grammar.core language module. Its parts are vars, so reloading
this namespace is seen without reloading grammar.core. Its probes need
:sh/single-quote, so it goes after the core module.
sourceraw docstring

php-chrclj

(php-chr s)

PHP expression with no quote characters at all: the UTF-8 bytes of s mapped through chr and joined. Carries any byte, NUL included.

PHP expression with no quote characters at all: the UTF-8 bytes of s
mapped through chr and joined. Carries any byte, NUL included.
sourceraw docstring

php-singleclj

(php-single s)

PHP single-quoted string. Only \ and ' are escapes inside; every other byte is literal. nil for NUL: program text travels as an argv word.

PHP single-quoted string. Only \\ and \' are escapes inside; every
other byte is literal. nil for NUL: program text travels as an argv word.
sourceraw docstring

probesclj

Run after grammar.probe/probes, which proves the :sh/single-quote these need. A function disabled with disable_functions answers function_exists false, so its probe prints no and the verdict is :no.

Run after grammar.probe/probes, which proves the :sh/single-quote these need.
A function disabled with disable_functions answers function_exists false,
so its probe prints no and the verdict is :no.
sourceraw docstring

realizationsclj

source

wrappersclj

source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close