Re: [PHP-DOC] documentation update needs to be committed
Ok, now I just need to figure out why the heck I had checked out phpdoc as 'cvsread' instead of my user... Sorry about that, think I had one too many energy drinks last night. -Brad Nuno Lopes wrote: I've cheked the the permissions, and you still have phpdoc write access. So go ahead and commit the documentation yourself Nuno - Original Message - At one point in time, I had phpdoc cvs commit access, I guess I do not any more... (username bradmssw). I've got a fairly substantial documentation update that needs to be committed to phpdoc for mcve. I've attached a .tar.gz of the mcve subdirectory of phpdoc/en/reference/ with the exact contents it needs. You will notice a lot of removals from the functions/ directory (all of the mcve- functions, have become m- ... this has been true for a couple of years now). The function xml files were generated using xml_proto.php from the scripts directory of phpdoc... This update also references some other important changes, like the name change from MCVE -> Monetra, yet the actual module name for PHP has not changed. As well as the move to PECL. If someone could grant me commit access I can do this myself, otherwise if someone would be so kind as to commit this for me I would appreciate it... Also, one reference in entities/global.ent needs to be updated as well: Index: global.ent === RCS file: /repository/phpdoc/entities/global.ent,v retrieving revision 1.249 diff -u -r1.249 global.ent --- global.ent 2 Nov 2005 20:45:31 - 1.249 +++ global.ent 15 Nov 2005 04:10:10 - @@ -174,7 +174,7 @@ "http://dev.mysql.com/doc/maxdb/en/98/11b83fa6b33c17e1000a114084/frameset.htm";> http://mcal.chek.com/";> http://www.mainstreetsoftworks.com/";> -http://www.mainstreetsoftworks.com/docs/phpapi.pdf";> +http://www.mainstreetsoftworks.com/documentation.html";> http://mcrypt.sourceforge.net/";> http://ftp.emini.dk/pub/php/win32/mcrypt/";> http://www.ciphersbyritter.com/GLOSSARY.HTM#IV";> Thanks! -Brad
[PHP-DOC] cvs: phpdoc /entities global.ent
bradmsswTue Nov 15 15:37:51 2005 EDT Modified files: /phpdoc/entitiesglobal.ent Log: mcve: update documentation location http://cvs.php.net/diff.php/phpdoc/entities/global.ent?r1=1.249&r2=1.250&ty=u Index: phpdoc/entities/global.ent diff -u phpdoc/entities/global.ent:1.249 phpdoc/entities/global.ent:1.250 --- phpdoc/entities/global.ent:1.249Wed Nov 2 15:45:31 2005 +++ phpdoc/entities/global.ent Tue Nov 15 15:37:50 2005 @@ -1,6 +1,6 @@
[PHP-DOC] documentation update needs to be committed
At one point in time, I had phpdoc cvs commit access, I guess I do not any more... (username bradmssw). I've got a fairly substantial documentation update that needs to be committed to phpdoc for mcve. I've attached a .tar.gz of the mcve subdirectory of phpdoc/en/reference/ with the exact contents it needs. You will notice a lot of removals from the functions/ directory (all of the mcve- functions, have become m- ... this has been true for a couple of years now). The function xml files were generated using xml_proto.php from the scripts directory of phpdoc... This update also references some other important changes, like the name change from MCVE -> Monetra, yet the actual module name for PHP has not changed. As well as the move to PECL. If someone could grant me commit access I can do this myself, otherwise if someone would be so kind as to commit this for me I would appreciate it... Also, one reference in entities/global.ent needs to be updated as well: Index: global.ent === RCS file: /repository/phpdoc/entities/global.ent,v retrieving revision 1.249 diff -u -r1.249 global.ent --- global.ent 2 Nov 2005 20:45:31 - 1.249 +++ global.ent 15 Nov 2005 04:10:10 - @@ -174,7 +174,7 @@ "http://dev.mysql.com/doc/maxdb/en/98/11b83fa6b33c17e1000a114084/frameset.htm";> http://mcal.chek.com/";> http://www.mainstreetsoftworks.com/";> -"http://www.mainstreetsoftworks.com/docs/phpapi.pdf";> +"http://www.mainstreetsoftworks.com/documentation.html";> http://mcrypt.sourceforge.net/";> http://ftp.emini.dk/pub/php/win32/mcrypt/";> http://www.ciphersbyritter.com/GLOSSARY.HTM#IV";> Thanks! -Brad mcve-phpdoc.tar.gz Description: application/gzip
[PHP-DOC] cvs: phpdoc /en/reference/mcve reference.xml
bradmsswTue Jul 8 00:29:22 2003 EDT Modified files: /phpdoc/en/reference/mcve reference.xml Log: forgot to link in constants into reference.xml Index: phpdoc/en/reference/mcve/reference.xml diff -u phpdoc/en/reference/mcve/reference.xml:1.6 phpdoc/en/reference/mcve/reference.xml:1.7 --- phpdoc/en/reference/mcve/reference.xml:1.6 Mon Jul 7 23:52:00 2003 +++ phpdoc/en/reference/mcve/reference.xml Tue Jul 8 00:29:22 2003 @@ -1,5 +1,5 @@ - + MCVE Payment Functions MCVE @@ -40,8 +40,12 @@ for functions. + + &reference.mcve.constants; + + &reference.mcve.functions; -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] cvs: phpdoc /scripts xml_proto.php
bradmsswMon Jul 7 23:29:13 2003 EDT
Modified files:
/phpdoc/scripts xml_proto.php
Log:
problem with version check. Didn't work with PHP 5. Make it work now.
Index: phpdoc/scripts/xml_proto.php
diff -u phpdoc/scripts/xml_proto.php:1.8 phpdoc/scripts/xml_proto.php:1.9
--- phpdoc/scripts/xml_proto.php:1.8Thu May 22 12:57:18 2003
+++ phpdoc/scripts/xml_proto.phpMon Jul 7 23:29:13 2003
@@ -16,7 +16,7 @@
# | Authors: Brad House <[EMAIL PROTECTED]> |
# +--+
#
-# $Id: xml_proto.php,v 1.8 2003/05/22 16:57:18 philip Exp $
+# $Id: xml_proto.php,v 1.9 2003/07/08 03:29:13 bradmssw Exp $
*/
/*
@@ -667,8 +667,8 @@
function minimum_version($vercheck) {
$minver = explode(".", $vercheck);
$curver = explode(".", phpversion());
- if (($curver[0] < $minver[0]) || (($curver[0] = $minver[0]) && ($curver[1] <
$minver[1])) ||
- (($curver[0] = $minver[0]) && ($curver[1] = $minver[1]) && ($curver[2][0] <
$minver[2][0]))) {
+ if (($curver[0] < $minver[0]) || (($curver[0] == $minver[0]) && ($curver[1] <
$minver[1])) ||
+ (($curver[0] == $minver[0]) && ($curver[1] == $minver[1]) && ($curver[2][0] <
$minver[2][0]))) {
return false;
} else {
return true;
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP-DOC] cvs: phpdoc /scripts xml_proto.php
hah, oops, no wondering which project I work on -Brad Philip Olson wrote: philip Sun Oct 27 15:13:00 2002 EDT Modified files: /phpdoc/scripts xml_proto.php Log: mcve -> $extension_name Index: phpdoc/scripts/xml_proto.php diff -u phpdoc/scripts/xml_proto.php:1.4 phpdoc/scripts/xml_proto.php:1.5 --- phpdoc/scripts/xml_proto.php:1.4 Sun Oct 27 05:02:55 2002 +++ phpdoc/scripts/xml_proto.php Sun Oct 27 15:13:00 2002 @@ -16,7 +16,7 @@ # | Authors: Brad House <[EMAIL PROTECTED]> | # +--+ # -# $Id: xml_proto.php,v 1.4 2002/10/27 10:02:55 goba Exp $ +# $Id: xml_proto.php,v 1.5 2002/10/27 20:13:00 philip Exp $ */ /* @@ -164,7 +164,7 @@ "\n" . " \n" . " \n" . - " &reference.mcve.functions;\n" . + " &reference." . $extension_name . ".functions;\n" . " \n" . "
[PHP-DOC] New xml_proto.php -- greatly improved
Ok, been working hard on this new version, but I think
everyone is going to like what's been done.
It can now scan php4/ext/standard/*.c with only a couple
of small errors output (because of improper protos actually)
Though one drawback to having wildcard expansion is that
it now requires PHP-4.3.0-pre1 or higher for use of the
glob() function.
CHANGELOG:
10/26/02 v2.0 - Additional scanning for constants, and generation of
constants.xml
- Generation of references.xml template
- functions with optional arguments would not parse
properly, now it does
- Wildcard scanning is now allowed
- Requires PHP 4.3.0-pre1 or higher now
- Usage is totally different
-Brad
http://www.php.net/license/2_02.txt. |
# | If uou did not receive a copy of the PHP license and are unable to |
# | obtain it through the world wide web, please send a note to |
# | [EMAIL PROTECTED] so we can mail you a copy immediately|
# +--+
# | Authors: Brad House <[EMAIL PROTECTED]> |
# +--+
#
# $Id: xml_proto.php,v 1.3 2002/10/24 21:48:43 philip Exp $
*/
/*
REQUIRES: PHP 4.3.0-pre1 or higher
This program generates XML documentation from the C source code
of the extension. For functions, the code _must_ have protos,
for constants, the raw source code will be read and interpretted
to generate the constants.xml file
XML_PROTO v2.0 : Generate PHP documentation from proto defs (req PHP 4.3.0-pre1+)
Usage: php xml_proto.php [opts]
Ex: php xml_proto.php mcve /php4/ext/mcve/*.c
Options:
-C : generate only constants.xml file (in current directory)
-F : generate only fuction reference files (all will be placed in current
directory)
-A : (default) generate full documentation template
This will generate / directory which reference.xml and
contents.xml
will be created in, and a subdirectory /functions/ which all
function xml reference files will be generated in
*/
/* CHANGELOG:
10/??/02 v1.0 - Original Release
10/??/02 v1.1 - replace & with &
10/??/02 v1.2 - the Revision would be changed in static text meant for
insert into generated XML files (CVS did it)
10/26/02 v2.0 - Additional scanning for constants, and generation of constants.xml
- Generation of references.xml template
- functions with optional arguments would not parse properly, now it
does
- Wildcard scanning is now allowed
- Requires PHP 4.3.0-pre1 or higher now
- Usage is totally different
*/
$version="2.0";
$funclist=array();
$num_funcs=0;
$constlist=array();
$num_const=0;
$generate_constants=1;
$generate_functions=1;
$source_files=array();
$extension_name="";
$constant_dir="";
$function_dir="";
function new_function()
{
global $funclist, $num_funcs;
$funclist[$num_funcs]["args"]=array();
$funclist[$num_funcs]["num_args"]=0;
$num_funcs++;
return($num_funcs-1);
}
function fix_name($name)
{
$ret="";
$len=strlen($name);
for ($i=0; $i<$len; $i++) {
$c=substr($name, $i, 1);
if ($c == '_') {
$ret .= '-';
} else {
$ret .= $c;
}
}
return($ret);
}
function function_add_name($num, $name)
{
global $funclist, $num_funcs;
$funclist[$num]["function_name"]=$name;
$funclist[$num]["function_name_fix"]=fix_name($name);
return(1);
}
function function_add_type($num, $type)
{
global $funclist, $num_funcs;
$funclist[$num]["function_type"]=$type;
return(1);
}
function function_add_purpose($num, $purpose)
{
global $funclist, $num_funcs;
$funclist[$num]["purpose"]=$purpose;
return(1);
}
function function_add_arg($num, $type, $argname, $isopt)
{
global $funclist, $num_funcs;
$num_args=$funclist[$num]["num_args"];
$funclist[$num]["args"][$num_args]["type"]=$type;
$funclist[$num]["args"][$num_args]["variable"]=$argname;
$funclist[$num]["args"][$num_args]["isopt"]=$isopt;
$funclist[$num]["num_args"]++;
return(1);
}
function write_reference_xml()
{
global $extension_name, $constant_dir, $version;
$filename= $constant_dir. "reference.xml";
$fp=fopen($filename, "wb");
if (!$fp) {
echo "Failed writing: $filename\n";
return(0);
}
fwrite($fp, "\n" .
"\n" .
"\n" .
" \n" .
" $extension_name Functions\n" .
" $extension_name\n" .
&
Re: [PHP-DOC] cvs: phpdoc /en/reference/mcve/functions mcve-completeauthorizations.xml
Yeah, that str_replace is fine, add it... I wrote that
thing is such a short amount of time, I guess I didn't
attempt to forsee stuff like &.
Anyhow, I'm not really sure of PHP data types, I'm
more of a C person, but what it creates is an array
of integers. You pass the array by reference, and
the return value of the actual function is the number
of elements that get filled into the array. It really
doesn't need to happen that way, and that function will
probably change (it was necessary to be this way in C, but
in PHP, it's overkill, all PHP itself maintains a count
of elements in a PHP array)
-Brad
Philip Olson wrote:
This would stop this from happening in the future, any
possible problems?
- $argname = $funclist[$i]["args"][$j]["variable"];
+ $argname = str_replace('&', '&', $funclist[$i]["args"][$j]["variable"]);
Our only concern here is '&' right? This is in reference
(pun intended) to phpdoc/scripts/xml_proto.php
On a related note, is this particular proto correct? A type
int array reference?!
Regards,
Philip
On Thu, 24 Oct 2002, Philip Olson wrote:
philip Thu Oct 24 15:42:02 2002 EDT
Modified files:
/phpdoc/en/reference/mcve/functions mcve-completeauthorizations.xml
Log:
& -> &
Index: phpdoc/en/reference/mcve/functions/mcve-completeauthorizations.xml
diff -u phpdoc/en/reference/mcve/functions/mcve-completeauthorizations.xml:1.3 phpdoc/en/reference/mcve/functions/mcve-completeauthorizations.xml:1.4
--- phpdoc/en/reference/mcve/functions/mcve-completeauthorizations.xml:1.3 Sun Oct 20 23:28:14 2002
+++ phpdoc/en/reference/mcve/functions/mcve-completeauthorizations.xml Thu Oct 24 15:42:01 2002
@@ -1,5 +1,5 @@
-
+
mcve_completeauthorizations
@@ -10,7 +10,7 @@
intmcve_completeauthorizations
resourceconn
- int&array
+ int&array
&warn.undocumented.func;
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] /scripts xml_proto.c -- PHP conversion
ok, here's a php version ... I think it works ... hah
anyhow, you may want to get rid of the C version,
and just put this one in there
-Brad
Philip Olson wrote:
Hi Brad-
I think it's great that you worried about
register_globals, I also worry about it and
feel no public script (or my own for that
matter) should rely on it being on. There
is no need to.
Anyway, just a "thanks" :)
Philip
P.S. http://www.php.net/features.commandline
P.S.S. Oh dear, that man page assumes
register_globals being on! Will change
that sometime.
On Mon, 21 Oct 2002, Brad House wrote:
found it:
http://www.php.net/manual/en/reserved.variables.php#reserved.variables.server
it's $argc=$_SERVER["argc"];
$argv=$_SERVER["argv"];
for future reference...
-Brad
Gabor Hojtsy wrote:
what I really meant, was is there a way to do
it if register_globals was off? There's
obviously $_COOKIE[""] $_POST[""] stuff
like that, is there $_ARGV[""] ?? want
to make sure it works no matter what if
I'm going to go through the trouble
I don't know anything about $_ARGV
Goba
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
\n" .
"\n" .
" \n" .
" \n" .
"$funcname\n" .
"$purpose\n" .
" \n" .
" \n" .
"Description\n" .
"\n" .
" $functype$funcname\n");
for ($j=0; $j<$funclist[$i]["num_args"]; $j++) {
$argtype=$funclist[$i]["args"][$j]["type"];
$argname=$funclist[$i]["args"][$j]["variable"];
fwrite($fp, "
$argtype$argname\n");
}
if ($funclist[$i]["num_args"] == 0){
fwrite($fp, " \n");
}
fwrite($fp, "\n" .
"\n" .
" &warn.undocumented.func;\n" .
"\n" .
" \n" .
" \n" .
"\n" .
"\n");
fclose($fp);
echo "Wrote: $filename\n";
}
return(1);
}
function read_file($filename)
{
$fp = fopen($filename, "rb");
if ($fp == 0) return("");
$buffer=fread($fp, filesize($filename));
fclose($fp);
return($buffer);
}
function parse_desc($func_num, $data)
{
$len=0;
$i=0;
$c=0;
$temp="";
$temp_len=0;
$spaces=0;
$len=strlen($data);
for ($i=0; $i<$len; $i++) {
$c=substr($data, $i, 1);
switch ($c) {
case '\r':
case '\n':
case ' ':
if (!$spaces) {
$spaces=1;
$temp .= ' ';
$temp_len++;
}
break;
default:
if ($c != '\r' && $c != '\n') {
$spaces=0;
$temp .= $c;
$temp_len++;
}
break;
}
}
function_add_purpose($func_num, $temp);
return(1);
}
function parse_proto($proto)
{
$len=0;
$i=0;
$c=0;
$done=0;
$start=0;
$func_number=-1;
$got_proto_def=0;
$got_proto_type=0;
$got_proto_name=0;
$got_arg_type=0;
$start_args=0;
$temp="";
$temp2="";
$temp_len=0;
$len=strlen($proto);
for ($i=0; $i<$len; $i++) {
$c=substr($proto, $i, 1);
switch ($c) {
case '\r':
case '\n':
case ' ':
if ($temp_len) {
if (!$got_proto_def) {
if (strcasecmp($temp, "proto") != 0) {
echo "Not a proper proto definition: $proto\n";
return(0);
} else {
$got_proto_def=1;
}
} else if (!$got_proto_type) {
$func_number=new_function();
function_add_type($func_number, $temp);
$got_proto_type=1;
} else if (!$got_proto_name) {
function_add_name($func_number, $temp);
$got_proto_name=1;
} else if ($start_args && !$got_arg_type) {
$got_arg_type=1;
$temp2=$temp;
} else if ($start_args && $got_arg_type) {
$got_arg_type=0;
function_add_arg($func_number, $temp2, $temp);
$temp2="";
}
$temp_len=0;
$temp="";
}
break;
case '(':
if ($got_proto_type && $got_proto_def &&!$got_proto_name) {
function_add_name($func_number, $temp);
$temp="";
$temp_len=0;
$start_args=1;
$got_proto_na
Re: [PHP-DOC] Generation of documentation
Nevermind on this ... I wrote a quick C program to do this
for me. I've attached it for anyone else that wants it
Just:
gcc -Wall -O3 -o xml_proto xml_proto.c
Then pass the php extension.c file to the new program,
and it will spit out a crapload of files based on
the protos. Worked for me.
-Brad
Gabor Hojtsy wrote:
Is there a script available to generate the necessary base .xml
files by reading the proto definitions of an extension?
It appears as though there must/might be. If so, I need to
run it on the mcve extension. If not, please let me know
too, so I can get started on the long way around.
Well, I don't know of such a script. There are skeletons in the howto,
but those are not up to date, so please see an extension's current
documentation and start from that. I'll update the howto this week,
if noone does it before me.
Goba
#include
#include
#include
#include
typedef struct XML_proto {
char type[255];
char variable[255];
} XML_proto;
typedef struct XML_functions {
char function_type[255];
char function_name[255];
char function_name_fix[255];
char purpose[1024];
int num_args;
XML_proto *args;
} XML_functions;
XML_functions *funclist=NULL;
int num_funcs=0;
int new_function()
{
funclist=(XML_functions *)realloc(funclist, (num_funcs+1)*sizeof(XML_functions));
funclist[num_funcs].function_name[0]=0;
funclist[num_funcs].function_name_fix[0]=0;
funclist[num_funcs].purpose[0]=0;
funclist[num_funcs].num_args=0;
funclist[num_funcs].args=NULL;
num_funcs++;
return(num_funcs-1);
}
char *fix_name(char *name)
{
int len, i;
char *ret=NULL;
len=strlen(name);
ret=(char *)malloc((len+1)*sizeof(char));
memset(ret, 0, len+1);
for (i=0; i\n"
"\n");
fprintf(fp, " \n",
funclist[i].function_name_fix);
fprintf(fp, " \n"
"%s\n"
"%s\n",
funclist[i].function_name, funclist[i].purpose);
fprintf(fp, " \n"
" \n"
"Description\n"
"\n");
fprintf(fp, " %s%s\n",
funclist[i].function_type, funclist[i].function_name);
for (j=0; j%s%s\n",
funclist[i].args[j].type, funclist[i].args[j].variable);
}
if (funclist[i].num_args == 0){
fprintf(fp, " \n");
}
fprintf(fp, "\n"
// " &warn.experimental.func;\n"
"\n"
" &warn.undocumented.func;\n"
"\n"
" \n"
" \n"
"\n"
"\n");
fclose(fp);
printf("Wrote: %s\n", filename);
}
return(1);
}
long file_length(FILE *fp)
{
long pos, len;
pos=ftell(fp);
fseek(fp, 0L, SEEK_END);
len=ftell(fp);
fseek(fp, pos, SEEK_SET);
return(len);
}
char *read_file(char *filename)
{
FILE *fp;
char *buffer=NULL;
long len;
fp=fopen(filename, "rb");
if (fp == NULL) return(NULL);
len=file_length(fp);
buffer=(char *)malloc((len+1)*sizeof(char));
memset(buffer, 0, len+1);
fread(buffer, len, sizeof(char), fp);
fclose(fp);
return(buffer);
}
char *midstr(char *string, long start, long len)
{
char *ret=NULL;
char *ptr=NULL;
ret=(char *)malloc((len+1)*sizeof(char));
ptr=string+start;
memset(ret, 0, len+1);
memcpy(ret, ptr, len);
return(ret);
}
int parse_desc(int func_num, char *data)
{
long len, i;
int c;
char temp[1024];
int temp_len=0;
int spaces=0;
temp[0]=0;
len=strlen(data);
for (i=0; i\n", argv[0]);
return(2);
}
contents=read_file(argv[1]);
if (contents == NULL) {
printf("Could not read %s\n", argv[1]);
}
parse_file(contents);
free(contents);
write_xml_files();
return(1);
}
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP-DOC] cvs: phpdoc /scripts xml_proto.c
I probably would have written it in PHP, if I knew how to get arguments off the command line ... If someone could tell me how to do that, I'd be glad to convert it to PHP -Brad Gabor Hojtsy wrote: goba Mon Oct 21 11:53:27 2002 EDT Added files: /phpdoc/scripts xml_proto.c Log: Adding Brad's xml proto program so others can make use of it BTW it will probably be a good idea to port it to PHP ;P [sometime later!] -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP-DOC] cvs: phpdoc /scripts xml_proto.c
found it: http://www.php.net/manual/en/reserved.variables.php#reserved.variables.server it's $argc=$_SERVER["argc"]; $argv=$_SERVER["argv"]; for future reference... -Brad Gabor Hojtsy wrote: what I really meant, was is there a way to do it if register_globals was off? There's obviously $_COOKIE[""] $_POST[""] stuff like that, is there $_ARGV[""] ?? want to make sure it works no matter what if I'm going to go through the trouble I don't know anything about $_ARGV Goba -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] cvs: phpdoc / manual.xml.in
bradmsswSun Oct 20 23:33:33 2002 EDT Modified files: /phpdoc manual.xml.in Log: uncomment mcve extension docs Index: phpdoc/manual.xml.in diff -u phpdoc/manual.xml.in:1.137 phpdoc/manual.xml.in:1.138 --- phpdoc/manual.xml.in:1.137 Fri Oct 11 14:30:59 2002 +++ phpdoc/manual.xml.inSun Oct 20 23:33:33 2002 @@ -78,10 +78,9 @@ - + &reference.apache.reference; &reference.array.reference; &reference.aspell.reference; @@ -96,7 +95,7 @@ &reference.curl.reference; &reference.cybercash.reference; &reference.cybermut.reference; - &reference.cyrus.reference; + &reference.cyrus.reference; &reference.ctype.reference; &reference.dba.reference; &reference.datetime.reference; @@ -136,6 +135,7 @@ &reference.mbstring.reference; &reference.mcal.reference; &reference.mcrypt.reference; + &reference.mcve.reference; &reference.mhash.reference; &reference.mime-magic.reference; &reference.mssql.reference; -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] cvs: phpdoc /en/reference/mcve/functions mcve-adduser.xml mcve-adduserarg.xml mcve-bt.xml mcve-checkstatus.xml mcve-chkpwd.xml mcve-chngpwd.xml mcve-completeauthorizations.xml mcve-connect.xml mcve-connectionerror.xml mcve-deleteresponse.xml mcve-deletetrans.xml mcve-deleteusersetup.xml mcve-deluser.xml mcve-destroyconn.xml mcve-destroyengine.xml mcve-disableuser.xml mcve-edituser.xml mcve-enableuser.xml mcve-force.xml mcve-getcell.xml mcve-getcellbynum.xml mcve-getcommadelimited.xml mcve-getheader.xml mcve-getuserarg.xml mcve-getuserparam.xml mcve-gft.xml mcve-gl.xml mcve-gut.xml mcve-initconn.xml mcve-initengine.xml mcve-initusersetup.xml mcve-iscommadelimited.xml mcve-liststats.xml mcve-listusers.xml mcve-maxconntimeout.xml mcve-monitor.xml mcve-numcolumns.xml mcve-numrows.xml mcve-override.xml mcve-parsecommadelimited.xml mcve-ping.xml mcve-preauth.xml mcve-preauthcompletion.xml mcve-qc.xml mcve-responseparam.xml mcve-return.xml mcve-returncode.xml mcve-returnstatus.xml mcve-sale.xml mcve-setblocking.xml mcve-setdropfile.xml mcve-setip.xml mcve-setssl.xml mcve-settimeout.xml mcve-settle.xml mcve-text-avs.xml mcve-text-code.xml mcve-text-cv.xml mcve-transactionauth.xml mcve-transactionavs.xml mcve-transactionbatch.xml mcve-transactioncv.xml mcve-transactionid.xml mcve-transactionitem.xml mcve-transactionssent.xml mcve-transactiontext.xml mcve-transinqueue.xml mcve-transnew.xml mcve-transparam.xml mcve-transsend.xml mcve-ub.xml mcve-uwait.xml mcve-verifyconnection.xml mcve-verifysslcert.xml mcve-void.xml
bradmsswSun Oct 20 23:28:15 2002 EDT Added files: /phpdoc/en/reference/mcve/functions mcve-connectionerror.xml mcve-deletetrans.xml mcve-getuserparam.xml mcve-maxconntimeout.xml mcve-ping.xml mcve-responseparam.xml mcve-setblocking.xml mcve-text-avs.xml mcve-text-code.xml mcve-text-cv.xml mcve-transnew.xml mcve-transparam.xml mcve-transsend.xml mcve-uwait.xml mcve-verifyconnection.xml mcve-verifysslcert.xml Modified files: /phpdoc/en/reference/mcve/functions mcve-adduser.xml mcve-adduserarg.xml mcve-bt.xml mcve-checkstatus.xml mcve-chkpwd.xml mcve-chngpwd.xml mcve-completeauthorizations.xml mcve-connect.xml mcve-deleteresponse.xml mcve-deleteusersetup.xml mcve-deluser.xml mcve-destroyconn.xml mcve-destroyengine.xml mcve-disableuser.xml mcve-edituser.xml mcve-enableuser.xml mcve-force.xml mcve-getcell.xml mcve-getcellbynum.xml mcve-getcommadelimited.xml mcve-getheader.xml mcve-getuserarg.xml mcve-gft.xml mcve-gl.xml mcve-gut.xml mcve-initconn.xml mcve-initengine.xml mcve-initusersetup.xml mcve-iscommadelimited.xml mcve-liststats.xml mcve-listusers.xml mcve-monitor.xml mcve-numcolumns.xml mcve-numrows.xml mcve-override.xml mcve-parsecommadelimited.xml mcve-preauth.xml mcve-preauthcompletion.xml mcve-qc.xml mcve-return.xml mcve-returncode.xml mcve-returnstatus.xml mcve-sale.xml mcve-setdropfile.xml mcve-setip.xml mcve-setssl.xml mcve-settimeout.xml mcve-settle.xml mcve-transactionauth.xml mcve-transactionavs.xml mcve-transactionbatch.xml mcve-transactioncv.xml mcve-transactionid.xml mcve-transactionitem.xml mcve-transactionssent.xml mcve-transactiontext.xml mcve-transinqueue.xml mcve-ub.xml mcve-void.xml Log: syncing docs with function protos Index: phpdoc/en/reference/mcve/functions/mcve-adduser.xml diff -u phpdoc/en/reference/mcve/functions/mcve-adduser.xml:1.2 phpdoc/en/reference/mcve/functions/mcve-adduser.xml:1.3 --- phpdoc/en/reference/mcve/functions/mcve-adduser.xml:1.2 Wed Apr 17 02:40:14 2002 +++ phpdoc/en/reference/mcve/functions/mcve-adduser.xml Sun Oct 20 23:28:14 2002 @@ -1,10 +1,9 @@ - - + mcve_adduser -Add an MCVE user using usersetup structure + Add an MCVE user using usersetup structure Description @@ -14,7 +13,6 @@
[PHP-DOC] cvs: phpdoc /en/reference/mcve reference.xml
bradmsswSun Oct 20 23:31:03 2002 EDT Modified files: /phpdoc/en/reference/mcve reference.xml Log: initial real docs Index: phpdoc/en/reference/mcve/reference.xml diff -u phpdoc/en/reference/mcve/reference.xml:1.3 phpdoc/en/reference/mcve/reference.xml:1.4 --- phpdoc/en/reference/mcve/reference.xml:1.3 Tue Jul 23 05:34:49 2002 +++ phpdoc/en/reference/mcve/reference.xml Sun Oct 20 23:31:02 2002 @@ -1,16 +1,69 @@ - + - MCVE functions - MCVE functions + MCVE Payment Functions + MCVE &reftitle.intro; - &warn.experimental; + These functions interface the MCVE API (libmcve), allowing you + to work directly with MCVE from your PHP scripts. MCVE is + Main Street Softworks' solution to direct credit card processing. + It lets you directly address the credit card clearing houses via + your *nix box, modem and/or internet connection (bypassing the + need for an additional service such as Authorize.Net or Pay + Flow Pro). Using the MCVE module for PHP, you can process + credit cards directly through MCVE via your PHP scripts. The + following references will outline the process. + + + MCVE is the replacement for RedHat's CCVS. They contracted with + RedHat in late 2001 to migrate all existing clientelle to the + MCVE platform. + + + +&reftitle.install; + + To enable MCVE Support in PHP, first verify your LibMCVE installation + directory. You will then need to configure PHP with the --with-mcve option. If you use this + option without specifying the path to your MCVE installation, PHP + will attempt to look in the default LibMCVE Install location + (/usr/local). If MCVE is in a non-standard location, run + configure with: --with-mcve=$mcve_path, where $mcve_path + is the path to your MCVE installation. Please note that MCVE + support requires that $mcve_path/lib and $mcve_path/include exist, + and include mcve.h under the include directory and libmcve.so and/or + libmcve.a under the lib directory. + + + Since MCVE has true server/client separation, there are no additional + requirements for running PHP with MCVE support. To test your + MCVE extension in PHP, you may connect to testbox.mcve.com on + port 8333 for IP, or port 8444 for SSL using the MCVE PHP API. + Use 'vitale' for your username, and 'test' for your password. + Additional information about test facilities are available at + http://www.mcve.com";>www.mcve.com. + + + + +&reftitle.seealso; + + Additional documentation about MCVE's PHP API can be found at + http://www.mcve.com/docs/phpapi.pdf";> + http://www.mcve.com/docs/phpapi.pdf. Main Street's + documentation is complete and should be the primary reference + for functions. + + + &reference.mcve.functions; -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] Generation of documentation
Is there a script available to generate the necessary base .xml files by reading the proto definitions of an extension? It appears as though there must/might be. If so, I need to run it on the mcve extension. If not, please let me know too, so I can get started on the long way around. Thanks. -Brad -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] auto-generation of prototype .xml files
It appears as though there was some sort of script run on the MCVE extension that auto-generated .xml files from the prototypes listed in the extension. Where can I get this script, or can someone run it for me before I start committing changes? There have been quite a few new functions added ... I found no reference in the howto for phpdoc. Also, the howto.html.tar.gz file as linked in the README file in the base phpdoc directory should actually be named howto.html.tar.gz.gz as it has been gzipped twice! If this was not a script, I definately thank whoever did all that work ;) -Brad -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP-DOC] Documentation for MCVE Extension
I've already got a php CVS account, though I'm not sure if I have permission to the phpdoc areas or not. My CVS username is bradmssw. Anyhow, I'm not even familiar with the way PHP documentation is structured. If someone could point me in the right direction, I'd appreciate it. Thanks. -Brad Rasmus Lerdorf wrote: > The easiest would be if you could apply for a cvs account and put these > docs into PHP's docbook framework. See http://www.php.net/cvs-php.php > > -Rasmus > > On Tue, 20 Aug 2002, Brad House wrote: > > >>I have constructed documentation for the MCVE extension. It >>is available for download at http://www.mcve.com/docs/phpapi.pdf >> >>Please advise me on what needs to be done to get the relevant >>info into the PHP documenatation. If nothing else, at least >>have the phpdocs remove the experimental status, and simply >>have the intro link this document. >> >>Thanks for your help. >> >>- >>Brad House >>Sr. Developer >>Main Street Softworks, Inc. >> >>[EMAIL PROTECTED] >>(352) 378-8228 >>- >> >> >>-- >>PHP Documentation Mailing List (http://www.php.net/) >>To unsubscribe, visit: http://www.php.net/unsub.php >> > -- - Brad House Sr. Developer Main Street Softworks, Inc. [EMAIL PROTECTED] (352) 378-8228 - -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP-DOC] Documentation for MCVE Extension
I have constructed documentation for the MCVE extension. It is available for download at http://www.mcve.com/docs/phpapi.pdf Please advise me on what needs to be done to get the relevant info into the PHP documenatation. If nothing else, at least have the phpdocs remove the experimental status, and simply have the intro link this document. Thanks for your help. - Brad House Sr. Developer Main Street Softworks, Inc. [EMAIL PROTECTED] (352) 378-8228 - -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
