├── .gitignore ├── DB_DataObject.php ├── LICENCE ├── Migration.plan.txt ├── PDO ├── DataObject.php └── DataObject │ ├── Cast.php │ ├── Exception.php │ ├── Generator.php │ ├── Generator │ ├── Column.php │ ├── Hooks.php │ └── Table.php │ ├── Introspection.php │ ├── Introspection │ ├── mysql.php │ ├── oci.php │ ├── pgsql.php │ └── sqlite.php │ ├── Join.php │ ├── Links.php │ ├── Validate.php │ └── createTables.php ├── README.md ├── composer.json ├── docs ├── Documentation.txt ├── build.bjs ├── build.js ├── categories.bjs ├── categories.json ├── config.bjs ├── config.js ├── create.bjs ├── create.js ├── creating-dataobjects.bjs ├── creating-dataobjects.js ├── crud.bjs ├── crud.js ├── db-dataobject-compatibility.bjs ├── db-dataobject-compatibility.js ├── debug.bjs ├── debug.js ├── doc.js ├── fetch.bjs ├── fetch.js ├── index.bjs ├── index.css ├── index.html ├── index.js ├── introduction.bjs ├── introduction.js ├── introspect.bjs ├── introspect.js ├── join.bjs ├── join.js ├── pdo-dataobject-cast │ ├── blob.bjs │ ├── canToValue.bjs │ ├── date.bjs │ ├── dateTime.bjs │ ├── isNull.bjs │ ├── raise.bjs │ ├── sql.bjs │ ├── string.bjs │ ├── time.bjs │ ├── toString.bjs │ ├── toStringFromBlob.bjs │ ├── toStringFromDate.bjs │ ├── toStringFromDateTime.bjs │ ├── toStringFromSql.bjs │ ├── toStringFromString.bjs │ ├── toStringFromTime.bjs │ └── toValue.bjs ├── pdo-dataobject-exception │ └── factory.bjs ├── pdo-dataobject-generator-column │ ├── __construct.bjs │ ├── new.bjs │ ├── toIni.bjs │ ├── toIniSequence.bjs │ ├── toLinks.bjs │ ├── toPhpDefault.bjs │ ├── toPhpGetter.bjs │ ├── toPhpKeyFunc.bjs │ ├── toPhpLinkMethod.bjs │ ├── toPhpSequenceFunc.bjs │ ├── toPhpSetter.bjs │ ├── toPhpTableFunc.bjs │ └── toPhpVar.bjs ├── pdo-dataobject-generator-hooks │ ├── __construct.bjs │ ├── classDocBlock.bjs │ ├── extendsDocBlock.bjs │ ├── functions.bjs │ ├── new.bjs │ ├── pageLevelDocBlock.bjs │ ├── postVar.bjs │ └── varDef.bjs ├── pdo-dataobject-generator-table │ ├── __construct.bjs │ ├── getMethodNameFromColumnName.bjs │ ├── new.bjs │ ├── readFromDB.bjs │ ├── toDatabaseStructureArray.bjs │ ├── toIniKeysArray.bjs │ ├── toIniSequenceArray.bjs │ ├── toIniString.bjs │ ├── toLinksIni.bjs │ ├── toPhp.bjs │ ├── toPhpClassName.bjs │ └── toPhpFileName.bjs ├── pdo-dataobject-generator │ ├── __construct.bjs │ ├── config.bjs │ ├── databaseStructureProxy.bjs │ ├── generateForeignKeys.bjs │ ├── generateIni.bjs │ ├── generatePhp.bjs │ ├── getProxyFull.bjs │ ├── introspection.bjs │ ├── new.bjs │ ├── newTable.bjs │ ├── readTableList.bjs │ ├── start.bjs │ ├── toIni.bjs │ ├── toLinksIni.bjs │ └── toPhp.bjs ├── pdo-dataobject-introspection │ ├── __construct.bjs │ ├── getListOf.bjs │ ├── getSpecialQuery.bjs │ ├── new.bjs │ └── tableInfo.bjs ├── pdo-dataobject-join │ ├── __construct.bjs │ ├── add.bjs │ ├── joinAddBC.bjs │ └── new.bjs ├── pdo-dataobject-links │ ├── __construct.bjs │ ├── applyLinks.bjs │ ├── getLink.bjs │ ├── getLinkArray.bjs │ ├── link.bjs │ ├── linkInfo.bjs │ └── new.bjs ├── pdo-dataobject-validate │ ├── new.bjs │ └── validate.bjs ├── pdo-dataobject.bjs ├── pdo-dataobject │ ├── PDO.bjs │ ├── _is_null.bjs │ ├── _is_null_member.bjs │ ├── applyLinks.bjs │ ├── autoJoin.bjs │ ├── config.bjs │ ├── count.bjs │ ├── count.js │ ├── databaseNickname.bjs │ ├── databaseStructure.bjs │ ├── debug.bjs │ ├── debugLevel.bjs │ ├── delete.bjs │ ├── escape.bjs │ ├── factory.bjs │ ├── factorySelf.bjs │ ├── fetch.bjs │ ├── fetchAll.bjs │ ├── fetchAllAssoc.bjs │ ├── find.bjs │ ├── formatValue.bjs │ ├── free.bjs │ ├── fromValue.bjs │ ├── generator.bjs │ ├── get.bjs │ ├── groupBy.bjs │ ├── having.bjs │ ├── insert.bjs │ ├── joinAdd.bjs │ ├── joinAll.bjs │ ├── keys.bjs │ ├── limit.bjs │ ├── link.bjs │ ├── linkArray.bjs │ ├── links.bjs │ ├── load.bjs │ ├── locking.bjs │ ├── modifyLimitQuery.bjs │ ├── new.bjs │ ├── orderBy.bjs │ ├── pid.bjs │ ├── query.bjs │ ├── quoteIdentifier.bjs │ ├── raise.bjs │ ├── reload.bjs │ ├── reset.bjs │ ├── result.bjs │ ├── save.bjs │ ├── select.bjs │ ├── selectAdd.bjs │ ├── selectAs.bjs │ ├── sequenceKey.bjs │ ├── set.bjs │ ├── setFrom.bjs │ ├── snapshot.bjs │ ├── sqlValue.bjs │ ├── table.bjs │ ├── tableColumns.bjs │ ├── tableName.bjs │ ├── toArray.bjs │ ├── toSelectSQL.bjs │ ├── union.bjs │ ├── unionAdd.bjs │ ├── update.bjs │ ├── useIndex.bjs │ ├── validate.bjs │ ├── where.bjs │ ├── whereAdd.bjs │ ├── whereAddIn.bjs │ ├── whereIn.bjs │ └── whereToString.bjs ├── results.bjs └── results.js ├── package2.xml └── tests ├── 00-runtests.txt ├── 01-quoteIdentifier.phpt ├── 02-dsn.phpt ├── 03-databaseStructure-errors.phpt ├── 03-databaseStructure-fakedb.phpt ├── 03-databaseStructure-read-ini.phpt ├── 03-databaseStructure-realdb-mysql.phpt ├── 03-databaseStructure-realdb-pgsql.phpt ├── 03-databaseStructure-realdb-sqlite.phpt ├── 04-modifyLimitQuery.phpt ├── 05-escape.phpt ├── 06-generator-fakedb-ini.phpt ├── 06-generator-fakedb-options.phpt ├── 06-generator-fakedb-to-files.phpt ├── 06-generator-realdb-compare.phpt ├── 06-generator-realdb-pgsql.phpt ├── 06-generator-realdb-sqlite.phpt ├── 07-factory.phpt ├── 08-get.phpt ├── 09-pid.phpt ├── 10-where.phpt ├── 11-whereIn.phpt ├── 12-orderBy.phpt ├── 13-groupBy.phpt ├── 14-having.phpt ├── 15-union.phpt ├── 16-select.phpt ├── 17-selectAs.phpt ├── 18-find.phpt ├── 19-fetch.phpt ├── 20-fetchAll.phpt ├── 21-insert.phpt ├── 22-update.phpt ├── 23-delete.phpt ├── 24-count.phpt ├── 25-load-save.phpt ├── 26-sqlValue.phpt ├── 27-setFrom-string-null-full.phpt ├── 27-setFrom-string-null-true.phpt ├── 27-setFrom.phpt ├── 28-toArray.phpt ├── 29-formatValue.phpt ├── 30-validate.phpt ├── 31-joinAdd.phpt ├── 32-autoJoin-joinAll.phpt ├── 33-tableColumns.phpt ├── 34-links.phpt ├── 35-link.phpt ├── 36-transactions-real-mysql.phpt ├── 36-transactions.phpt ├── 37-buffered.phpt ├── 38-config-databases.phpt ├── 39-config-schema-location.phpt ├── 40-class-prefix.phpt ├── 41-config-portability.phpt ├── 42-bug12.phpt ├── 43-update-after-where.phpt └── includes ├── EssentialSQL.db ├── PDO_Dummy.php ├── PDO_DummyStatement.php ├── gettest.ini ├── init.php ├── inserttest.ini ├── inserttest.links.ini ├── mysql_somedb.ini ├── pginsert.ini ├── run-tests.php ├── sample_classes ├── DataObjects_Account_code.php ├── DataObjects_Account_transaction.php ├── DataObjects_Childa.php ├── DataObjects_Childb.php ├── DataObjects_Companies.php ├── DataObjects_Customers.php ├── DataObjects_Dummy.php ├── DataObjects_Events.php ├── DataObjects_Joiner.php ├── DataObjects_Joinerb.php ├── DataObjects_Joinerc.php ├── Dummylong.php ├── Dummyshort.php ├── Percent_Events.php └── Percent_Inserttest_Events.php ├── sqlite_simple_test.php └── test_ini ├── Companies.php └── mysql_anotherdb.ini /.gitignore: -------------------------------------------------------------------------------- 1 | tests/*.diff 2 | tests/*.exp 3 | tests/*.log 4 | tests/*.out 5 | tests/*.php 6 | tests/*.sh 7 | *.tgz 8 | *.tgz.tmp 9 | 10 | -------------------------------------------------------------------------------- /DB_DataObject.php: -------------------------------------------------------------------------------- 1 | . 22 | * 23 | * @category Database 24 | * @package PDO_DataObject 25 | * @author Alan Knowles 26 | * @copyright 2016 Alan Knowles 27 | * @license https://www.gnu.org/licenses/lgpl-3.0.en.html LGPL 3 28 | * @version 1.0 29 | * @link https://github.com/roojs/PDO_DataObject 30 | */ 31 | 32 | // include path needs to be set up correctly..? 33 | 34 | require_once 'PDO/DataObject/Generator.php'; 35 | $do = new PDO_DataObject(); 36 | 37 | if (!ini_get('register_argc_argv')) { 38 | $do_>raise( 39 | "\nERROR: You must turn register_argc_argv On in you php.ini file for this to work\neg.\n\nregister_argc_argv = On\n\n"); 40 | } 41 | 42 | if (!@$_SERVER['argv'][1]) { 43 | $do_>raise("\nERROR: createTable.php usage:\n\nC:\php\pear\PDO\DataObjects\createTable.php example.ini\n\n"); 44 | exit; 45 | } 46 | 47 | $config = parse_ini_file($_SERVER['argv'][1], true); 48 | foreach($config as $class=>$values) { 49 | switch($class) { 50 | case 'PDO_DataObject': 51 | PDO_DataObject::config($values); 52 | break; 53 | 54 | case 'PDO_DataObject_Generator': 55 | PDO_DataObject_Generator::config($values); 56 | break; 57 | 58 | default: 59 | // skip... just ingore stuff.. 60 | } 61 | } 62 | 63 | 64 | 65 | set_time_limit(0); 66 | 67 | 68 | $generator = new PDO_DataObject_Generator(); 69 | $generator->start(); 70 | 71 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PDO_DataObject 2 | 3 | PDO replacement for PEAR's DB_DataObject 4 | 5 | Work has been funded by CentralNic Group plc 6 | 7 | --------------------- 8 | Manual : 9 | 10 | https://roojs.github.io/PDO_DataObject/docs/index.html 11 | 12 | --------------------- 13 | 14 | 15 | 16 | In General, this should be API compatible with DB_DataObject, except for 17 | * getDatabaseConnection(), which is replaced with PDOConnection() - and returns a PDO object, rather than a PEAR DB object. 18 | * staticGet() - has been removed 19 | * array of database (like a pool is no longer supported) - use a DB proxy 20 | 21 | Other Changes 22 | a) chained methods (prefixed with 'c', and throw exceptions) 23 | $key_value = DB_DAtaObject::Factory('table') 24 | ->cautoJoin() 25 | ->cwhere('A=12') 26 | ->climit(0,10) 27 | ->fetchAll('id','name'); 28 | 29 | b) Default behaviour is to throw exceptions (compatibility - PEAR::Error is available as a setting) 30 | 31 | c) Overloading has been removed - you should be able to wrap the DataObject and add it back in (it's not recommended - causes more problems than it solves) 32 | 33 | d) You can configure DataObjects direct by setting PDO_DataObject::$config - (if PEAR is not loaded, then PEAR::getStaticPropery will not be called...) 34 | 35 | --------------------- 36 | Commit Log 37 | 38 | * note we use git autocommit on save - so the early history does not have much valuable information - as we near completion, valid commit messages will be used. 39 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "roojs/pdo_dataobject", 3 | "type": "library", 4 | "description": "ORM based on PEAR::DB_DataObject ported for PHP5/7 and PDO", 5 | "keywords": ["orm"], 6 | "homepage": "https://github/roojs/PDO_DataObject#v0.0.4", 7 | "license": "LGPL-3.0", 8 | "authors": [ 9 | { 10 | "name": "Alan Knowles", 11 | "email": "alan@roojs.com" 12 | } 13 | ], 14 | "autoload": { 15 | "psr-0": { 16 | "PDO": "./" 17 | } 18 | }, 19 | "require-dev": { 20 | "php": ">=5.5" 21 | }, 22 | "config": { 23 | "secure-http": false 24 | } 25 | 26 | } -------------------------------------------------------------------------------- /docs/Documentation.txt: -------------------------------------------------------------------------------- 1 | This is generated by PHP_CodeDoc http://git.roojs.org/?p=PHP_CodeDoc;a=summary 2 | 3 | php ~/gitlive/PHP_CodeDoc/scripts/phpcodedoc ~/gitlive/PHP_CodeDoc/CodeDoc/ini_files/PDO_DataObject.ini -------------------------------------------------------------------------------- /docs/create.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name" : "create", 3 | "parent" : "", 4 | "title" : "", 5 | "path" : "/home/alan/gitlive/PDO_DataObject/docs/create.bjs", 6 | "permname" : "", 7 | "modOrder" : "001", 8 | "strings" : { 9 | "72caaab8039d8b75a86f805743b3716c" : "Creating instances of DataObjects", 10 | "6ed348e04674567827e341bb5b6d9d82" : "Example of using PDO_DataObjects", 11 | "a2a4c78ae5a110e9467fe679033c6d0b" : "

\nPDO_DataObjects was designed to be used with the factory method by default.\nWhile you can just create an instance of your child class, factory offers a number of advantages.\n

\n\n\n" 12 | }, 13 | "items" : [ 14 | { 15 | "xtype" : "Body", 16 | "$ xns" : "Roo.bootstrap", 17 | "items" : [ 18 | { 19 | "xtype" : "Header", 20 | "Number level" : 1, 21 | "$ xns" : "Roo.bootstrap", 22 | "String html" : "Creating instances of DataObjects" 23 | }, 24 | { 25 | "xtype" : "Element", 26 | "$ xns" : "Roo.bootstrap", 27 | "String html" : "

\nPDO_DataObjects was designed to be used with the factory method by default.\nWhile you can just create an instance of your child class, factory offers a number of advantages.\n

\n\n\n" 28 | }, 29 | { 30 | "xtype" : "Entry", 31 | "$ xns" : "Roo.doc", 32 | "items" : [ 33 | { 34 | "String lang" : "php", 35 | "xtype" : "Section", 36 | "$ xns" : "Roo.doc", 37 | "items" : [ 38 | { 39 | "String code" : "\n\n\n$e = PDO_DataObject::factory('Events')\n\n// create a new instance (or call it from a method in your events object.\n$e->factorySelf()\n\n// create a \n\n$e = new DataObject_Events();\n", 40 | "xtype" : "Example", 41 | "$ xns" : "Roo.doc", 42 | "String title" : "Example of using PDO_DataObjects" 43 | } 44 | ] 45 | } 46 | ] 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/doc.js: -------------------------------------------------------------------------------- 1 | Docs = { 2 | 3 | onReady : function() 4 | { 5 | Roo.XComponent.hideProgress = true; 6 | 7 | Roo.XComponent.build(); 8 | 9 | baseURL = window.location.pathname.replace(/index\.html$/, ''); 10 | 11 | 12 | } 13 | } 14 | 15 | Roo.onReady(Docs.onReady); -------------------------------------------------------------------------------- /docs/index.css: -------------------------------------------------------------------------------- 1 | .roo-child-ctr .nav>li { 2 | display: list-item; 3 | float: initial; 4 | } 5 | .roo-child-ctr .navbar-nav>li>a 6 | { 7 | padding-top: 2px; 8 | padding-bottom: 2px; 9 | } -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | PDO_DataObject Manual 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 43 | 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/blob.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "blob", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "blob", 10 | "purpose": " Blob consructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "blob", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "(with binary data!)", 27 | "is_optional": false, 28 | "name": "$value", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " create a Cast object from some raw data.. (binary)\n \n \n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/canToValue.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "canToValue", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "canToValue", 10 | "purpose": " can this property be converted to a plain value (for toArray)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "canToValue", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "bool", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/date.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "date", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "date", 10 | "purpose": " Date Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "date", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " create a Cast object from some string (not binary)\n NO VALIDATION DONE, although some crappy re-calcing done!\n \n\n\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/dateTime.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dateTime", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "dateTime", 10 | "purpose": " DateTime Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "dateTime", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " create a Cast object from a Date\/Time\n Maybe should accept a Date object.!\n NO VALIDATION DONE, although some crappy re-calcing done!\n \n\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/isNull.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "isNull", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "isNull", 10 | "purpose": " does this object representing a 'null' value...", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "isNull", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "bool", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " \n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/sql.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sql", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "sql", 10 | "purpose": " SQL constructor (for raw SQL insert)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "sql", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "(with binary data!)", 27 | "is_optional": false, 28 | "name": "$value", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " create a Cast object from some sql\n \n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/string.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "string", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "string", 10 | "purpose": " String consructor (actually use if for ints and everything else!!!", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "string", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "(with binary data!)", 27 | "is_optional": false, 28 | "name": "$value", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " create a Cast object from some string (not binary)\n \n \n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/time.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "time", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "time", 10 | "purpose": " time Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "time", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Cast", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " create a Cast object from a Date\/Time\n Maybe should accept a Date object.!\n NO VALIDATION DONE, and no-recalcing done!\n\n\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-cast/toValue.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toValue", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toValue", 10 | "purpose": " can this property be converted to a plain value (for toArray)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toValue", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Cast", 20 | "returndesc": "", 21 | "returntype": "bool", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toIni.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIni", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIni", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIni", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toIniSequence.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIniSequence", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIniSequence", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIniSequence", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toLinks.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toLinks", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toLinks", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toLinks", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpDefault.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpDefault", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpDefault", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpDefault", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpGetter.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpGetter", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpGetter", 10 | "purpose": " Generate getter methods for class definition", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpGetter", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "Existing class contents", 27 | "is_optional": false, 28 | "name": "$user_code", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpKeyFunc.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpKeyFunc", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpKeyFunc", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpKeyFunc", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpLinkMethod.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpLinkMethod", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpLinkMethod", 10 | "purpose": " Generate link setter\/getter methods for class definition", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpLinkMethod", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "Existing class contents", 27 | "is_optional": false, 28 | "name": "$user_code", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpSequenceFunc.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpSequenceFunc", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpSequenceFunc", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpSequenceFunc", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpSetter.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpSetter", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpSetter", 10 | "purpose": " Generate setter methods for class definition", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpSetter", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "Existing class contents", 27 | "is_optional": false, 28 | "name": "$user_code", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpTableFunc.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpTableFunc", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpTableFunc", 10 | "purpose": " map of types to id's ", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpTableFunc", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-column/toPhpVar.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpVar", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpVar", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpVar", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Column", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$var", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/__construct.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "__construct", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "memberof": "PDO_DataObject_Generator_Hooks", 19 | "returndesc": "", 20 | "returntype": "", 21 | "|xns": "Roo.doc", 22 | "xtype": "Synopsis", 23 | "items": [ 24 | { 25 | "desc": "", 26 | "is_optional": false, 27 | "name": "$gen", 28 | "type": "", 29 | "|xns": "Roo.doc", 30 | "xtype": "Param" 31 | } 32 | ] 33 | }, 34 | { 35 | "stype": "desc", 36 | "|xns": "Roo.doc", 37 | "xtype": "Section", 38 | "items": [ 39 | { 40 | "html": "

<\/p>", 41 | "|xns": "Roo.doc", 42 | "xtype": "Para" 43 | } 44 | ] 45 | }, 46 | { 47 | "stype": "parameter", 48 | "|xns": "Roo.doc", 49 | "xtype": "Section" 50 | }, 51 | { 52 | "stype": "return", 53 | "|xns": "Roo.doc", 54 | "xtype": "Section" 55 | }, 56 | { 57 | "stype": "example", 58 | "|xns": "Roo.doc", 59 | "xtype": "Section" 60 | } 61 | ] 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/classDocBlock.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "classDocBlock", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "classDocBlock", 10 | "purpose": " hook to add extra class level DocBlock (in terms of phpDocumentor)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "classDocBlock", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "added to class eg. functions.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$original", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " called once for each class, use it add extra comments to class\n string (require_once...)\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/extendsDocBlock.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "extendsDocBlock", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "extendsDocBlock", 10 | "purpose": " hook to add extra doc block (in terms of phpDocumentor) to extend string", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "extendsDocBlock", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "added to class eg. functions.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$original", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " called once for each class, use it add extra comments to extends\n string (require_once...)\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/functions.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "functions", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "functions", 10 | "purpose": " hook to add extra methods to all classes", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "functions", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "added to class eg. functions.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$original", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " called once for each class, use with $this->table and\n $this->_definitions[$this->table], to get data out of the current table,\n use it to add extra methods to the default classes.\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Generator_Hooks", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$gen", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/pageLevelDocBlock.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pageLevelDocBlock", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "pageLevelDocBlock", 10 | "purpose": " hook to add extra page-level (in terms of phpDocumentor) DocBlock", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "pageLevelDocBlock", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "added to class eg. functions.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$original", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " called once for each class, use it add extra page-level docs\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-hooks/postVar.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "postVar", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "postVar", 10 | "purpose": " hook for after var lines (", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "postVar", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Hooks", 20 | "returndesc": "added to class eg. functions.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "cols containing array of objects with type,len,flags etc. from tableInfo call", 27 | "is_optional": false, 28 | "name": "$columns_array", 29 | "type": "array", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " called at the end of the output of var line have generated, override to add extra var\n lines\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/getMethodNameFromColumnName.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "getMethodNameFromColumnName", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "getMethodNameFromColumnName", 10 | "purpose": " Convert a column name into a method name (usually prefixed by get\/set\/validateXXXXX)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "getMethodNameFromColumnName", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "method name;", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$col", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " Designed to be overidden if you really think it's a good idea?\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Generator_Table", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "- The calling geneator", 27 | "is_optional": false, 28 | "name": "$gen", 29 | "type": "PDO_DataObject_Generator", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | }, 33 | { 34 | "desc": "tablename to introspect and build.", 35 | "is_optional": false, 36 | "name": "$table", 37 | "type": "string", 38 | "|xns": "Roo.doc", 39 | "xtype": "Param" 40 | } 41 | ] 42 | }, 43 | { 44 | "stype": "desc", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section", 47 | "items": [ 48 | { 49 | "html": " Calls database introspection to fill information in.\n \n", 50 | "|xns": "Roo.doc", 51 | "xtype": "Para" 52 | } 53 | ] 54 | }, 55 | { 56 | "stype": "parameter", 57 | "|xns": "Roo.doc", 58 | "xtype": "Section" 59 | } 60 | ] 61 | } 62 | ] 63 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/readFromDB.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "readFromDB", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "readFromDB", 10 | "purpose": " read the database schema from the database", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "readFromDB", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toDatabaseStructureArray.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toDatabaseStructureArray", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toDatabaseStructureArray", 10 | "purpose": " return in a format suitable for databaseStructure", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toDatabaseStructureArray", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " [table] => array ( col => type, col, type)\n [table_keys] => array ( col => sequencetype|name )\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toIniKeysArray.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIniKeysArray", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIniKeysArray", 10 | "purpose": " return the 'table definition' associative array", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIniKeysArray", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " (refered to as 'keys')\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toIniSequenceArray.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIniSequenceArray", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIniSequenceArray", 10 | "purpose": " this is the ini array that relates to sequence keys", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIniSequenceArray", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " in the ini file, we output the key column, and the type of sequence (N|nextval_sequence_name)\n it can also have 'U' = unquie and 'K' = just a key...\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toIniString.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIniString", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIniString", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIniString", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toLinksIni.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toLinksIni", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toLinksIni", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toLinksIni", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toPhp.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhp", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhp", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhp", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$original", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toPhpClassName.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpClassName", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpClassName", 10 | "purpose": " Convert a table name into a class name -> override this if you want a different mapping", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpClassName", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "class name;", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator-table/toPhpFileName.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhpFileName", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhpFileName", 10 | "purpose": " Convert a table name into a file name -> override this if you want a different mapping", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhpFileName", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator_Table", 20 | "returndesc": "file name;", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/__construct.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "__construct", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "memberof": "PDO_DataObject_Generator", 19 | "returndesc": "", 20 | "returntype": "", 21 | "|xns": "Roo.doc", 22 | "xtype": "Synopsis", 23 | "items": [ 24 | { 25 | "desc": "database nickname", 26 | "is_optional": false, 27 | "name": "$cfg", 28 | "type": "string", 29 | "|xns": "Roo.doc", 30 | "xtype": "Param" 31 | } 32 | ] 33 | }, 34 | { 35 | "stype": "desc", 36 | "|xns": "Roo.doc", 37 | "xtype": "Section", 38 | "items": [ 39 | { 40 | "html": "

- although it extends PDO_DataObject, the ctor behavior is slightly different\n it expects a database nickname (optiontally)\n<\/p>", 41 | "|xns": "Roo.doc", 42 | "xtype": "Para" 43 | } 44 | ] 45 | }, 46 | { 47 | "stype": "parameter", 48 | "|xns": "Roo.doc", 49 | "xtype": "Section" 50 | }, 51 | { 52 | "stype": "return", 53 | "|xns": "Roo.doc", 54 | "xtype": "Section" 55 | }, 56 | { 57 | "stype": "example", 58 | "|xns": "Roo.doc", 59 | "xtype": "Section" 60 | } 61 | ] 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/generateForeignKeys.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generateForeignKeys", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "generateForeignKeys", 10 | "purpose": " generate Foreign Keys (for links.ini) ", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "generateForeignKeys", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " Currenly only works with mysql \/ mysqli\n to use, you must set option: generate_links=true\n \n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/generateIni.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generateIni", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "generateIni", 10 | "purpose": " Create '.ini' files with database schema in them.", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "generateIni", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "none", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/generatePhp.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generatePhp", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "generatePhp", 10 | "purpose": " building the class files", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "generatePhp", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " for each of the tables output a file!\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/introspection.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "introspection", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "introspection", 10 | "purpose": " create an instance of introspection. ", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "introspection", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " - manual set\n - proxy\n - ini_****\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Generator", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "database nickname", 27 | "is_optional": false, 28 | "name": "$cfg", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " - although it extends PDO_DataObject, the ctor behavior is slightly different\n it expects a database nickname (optiontally)\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/newTable.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "newTable", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "newTable", 10 | "purpose": " Create an instance of the table class (which can be specified in config[table_gen_class])", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "newTable", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$name", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " \n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/readTableList.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "readTableList", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "readTableList", 10 | "purpose": " Build a list of tables and definitions.;", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "readTableList", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "of tables", 21 | "returntype": "Array", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " and store it in $this->tables and $this->_definitions[tablename];\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/start.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "start", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "start", 10 | "purpose": " The 'starter' = call this to start the process", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "start", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "none", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/toIni.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toIni", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toIni", 10 | "purpose": " fetch the content of '.ini' files with database schema in them.", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toIni", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "none", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/toLinksIni.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toLinksIni", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toLinksIni", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toLinksIni", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-generator/toPhp.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toPhp", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toPhp", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toPhp", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Generator", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$tablename", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-introspection/__construct.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "__construct", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "memberof": "PDO_DataObject_Introspection", 19 | "returndesc": "", 20 | "returntype": "", 21 | "|xns": "Roo.doc", 22 | "xtype": "Synopsis", 23 | "items": [ 24 | { 25 | "desc": "", 26 | "is_optional": false, 27 | "name": "$do", 28 | "type": "", 29 | "|xns": "Roo.doc", 30 | "xtype": "Param" 31 | } 32 | ] 33 | }, 34 | { 35 | "stype": "desc", 36 | "|xns": "Roo.doc", 37 | "xtype": "Section", 38 | "items": [ 39 | { 40 | "html": "

<\/p>", 41 | "|xns": "Roo.doc", 42 | "xtype": "Para" 43 | } 44 | ] 45 | }, 46 | { 47 | "stype": "parameter", 48 | "|xns": "Roo.doc", 49 | "xtype": "Section" 50 | }, 51 | { 52 | "stype": "return", 53 | "|xns": "Roo.doc", 54 | "xtype": "Section" 55 | }, 56 | { 57 | "stype": "example", 58 | "|xns": "Roo.doc", 59 | "xtype": "Section" 60 | } 61 | ] 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-introspection/getListOf.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "getListOf", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "getListOf", 10 | "purpose": " Lists internal database information", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "getListOf", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Introspection", 20 | "returndesc": "an array listing the items sought.\n Or throws an error..", 21 | "returntype": "array", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "type of information being sought.\n Common items being sought are:\n tables, databases, users, views, functions\n Each DBMS's has its own capabilities.", 27 | "is_optional": false, 28 | "name": "$type", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-introspection/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Introspection", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Introspection", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$do", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-introspection/tableInfo.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tableInfo", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "tableInfo", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "tableInfo", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Introspection", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$table", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-join/__construct.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "__construct", 10 | "purpose": " constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "memberof": "PDO_DataObject_Join", 19 | "returndesc": "", 20 | "returntype": "", 21 | "|xns": "Roo.doc", 22 | "xtype": "Synopsis", 23 | "items": [ 24 | { 25 | "desc": "", 26 | "is_optional": false, 27 | "name": "$dataObject", 28 | "type": "", 29 | "|xns": "Roo.doc", 30 | "xtype": "Param" 31 | } 32 | ] 33 | }, 34 | { 35 | "stype": "desc", 36 | "|xns": "Roo.doc", 37 | "xtype": "Section", 38 | "items": [ 39 | { 40 | "html": "

The primary dataObject to work on..\n<\/p>", 41 | "|xns": "Roo.doc", 42 | "xtype": "Para" 43 | } 44 | ] 45 | }, 46 | { 47 | "stype": "parameter", 48 | "|xns": "Roo.doc", 49 | "xtype": "Section" 50 | }, 51 | { 52 | "stype": "return", 53 | "|xns": "Roo.doc", 54 | "xtype": "Section" 55 | }, 56 | { 57 | "stype": "example", 58 | "|xns": "Roo.doc", 59 | "xtype": "Section" 60 | } 61 | ] 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-join/add.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "add", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "add", 10 | "purpose": "", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "add", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject_Join", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$obj", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | }, 33 | { 34 | "desc": "", 35 | "is_optional": false, 36 | "name": "$options", 37 | "type": "", 38 | "|xns": "Roo.doc", 39 | "xtype": "Param" 40 | } 41 | ] 42 | }, 43 | { 44 | "stype": "desc", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section", 47 | "items": [ 48 | { 49 | "html": "", 50 | "|xns": "Roo.doc", 51 | "xtype": "Para" 52 | } 53 | ] 54 | }, 55 | { 56 | "stype": "parameter", 57 | "|xns": "Roo.doc", 58 | "xtype": "Section" 59 | }, 60 | { 61 | "stype": "return", 62 | "|xns": "Roo.doc", 63 | "xtype": "Section" 64 | } 65 | ] 66 | } 67 | ] 68 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-join/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Join", 10 | "purpose": " constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Join", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$dataObject", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " The primary dataObject to work on..\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-links/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Links", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Links", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "DataObject to apply to.", 27 | "is_optional": false, 28 | "name": "$do", 29 | "type": "do", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | }, 33 | { 34 | "desc": "Configuration (basically properties of this object)", 35 | "is_optional": false, 36 | "name": "$cfg", 37 | "type": "cfg", 38 | "|xns": "Roo.doc", 39 | "xtype": "Param" 40 | } 41 | ] 42 | }, 43 | { 44 | "stype": "desc", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section", 47 | "items": [ 48 | { 49 | "html": " -- good ole style..\n", 50 | "|xns": "Roo.doc", 51 | "xtype": "Para" 52 | } 53 | ] 54 | }, 55 | { 56 | "stype": "parameter", 57 | "|xns": "Roo.doc", 58 | "xtype": "Section" 59 | } 60 | ] 61 | } 62 | ] 63 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject-validate/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject_Validate", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject_Validate", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "The object to validate.", 27 | "is_optional": false, 28 | "name": "$dataobject", 29 | "type": "PDO_DataObject", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "build": [ 3 | "__construct", 4 | "whereAdd", 5 | "where", 6 | "whereAddIn", 7 | "whereIn", 8 | "orderBy", 9 | "groupBy", 10 | "having", 11 | "useIndex", 12 | "unionAdd", 13 | "union", 14 | "limit", 15 | "selectAdd", 16 | "select", 17 | "selectAs", 18 | "escape", 19 | "whereToString", 20 | "sqlValue", 21 | "setFrom", 22 | "set", 23 | "fromValue", 24 | "validate" 25 | ], 26 | "introspect": [ 27 | "PDO", 28 | "quoteIdentifier", 29 | "modifyLimitQuery", 30 | "toSelectSQL", 31 | "databaseStructure", 32 | "tableName", 33 | "databaseNickname", 34 | "table", 35 | "tableColumns", 36 | "keys", 37 | "sequenceKey" 38 | ], 39 | "config": [ 40 | "config" 41 | ], 42 | "fetch": [ 43 | "get", 44 | "load", 45 | "reload", 46 | "find", 47 | "fetch", 48 | "fetchAll", 49 | "fetchAllAssoc", 50 | "count", 51 | "query", 52 | "generator" 53 | ], 54 | "results": [ 55 | "pid", 56 | "toArray", 57 | "formatValue" 58 | ], 59 | "crud": [ 60 | "insert", 61 | "update", 62 | "save", 63 | "snapshot", 64 | "delete" 65 | ], 66 | "create": [ 67 | "factorySelf", 68 | "factory" 69 | ], 70 | "join": [ 71 | "links", 72 | "link", 73 | "applyLinks", 74 | "linkArray", 75 | "joinAdd", 76 | "autoJoin" 77 | ], 78 | "intropect": [ 79 | "result" 80 | ], 81 | "debug": [ 82 | "debug", 83 | "debugLevel", 84 | "raise", 85 | "free" 86 | ], 87 | "@debug": [ 88 | "reset" 89 | ] 90 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/PDO.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "PDO", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "PDO", 10 | "purpose": " connects to the database and returns the [PDO](\/\/www.php.net\/PDO) object", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "PDO", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "Object the connection", 21 | "returntype": "PDO", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " Basedon the objects table and database settings it will connect to the database\n as set by the configuratino, and return the PDO object.\n\n the PDO object has `$PDO->dsn` set to and array, of which\n `$PDO->dsn['database_name']` should contain the real database name.\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/_is_null.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "_is_null", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "_is_null", 10 | "purpose": " Check a value, to see if it matches our 'null' rules", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "_is_null", 17 | "is_static": true, 18 | "memberof": "PDO_DataObject", 19 | "returndesc": "object", 20 | "returntype": "bool", 21 | "|xns": "Roo.doc", 22 | "xtype": "Synopsis", 23 | "items": [ 24 | { 25 | "desc": "$value", 26 | "is_optional": false, 27 | "name": "$value", 28 | "type": "mixed", 29 | "|xns": "Roo.doc", 30 | "xtype": "Param" 31 | } 32 | ] 33 | }, 34 | { 35 | "stype": "desc", 36 | "|xns": "Roo.doc", 37 | "xtype": "Section", 38 | "items": [ 39 | { 40 | "html": "

normally real null, and CAST('null') will match\n if you have enable_null_strings (not recommended) then string 'null' will also return true.<\/p>

<\/p>", 41 | "|xns": "Roo.doc", 42 | "xtype": "Para" 43 | } 44 | ] 45 | }, 46 | { 47 | "stype": "parameter", 48 | "|xns": "Roo.doc", 49 | "xtype": "Section" 50 | }, 51 | { 52 | "stype": "return", 53 | "|xns": "Roo.doc", 54 | "xtype": "Section" 55 | }, 56 | { 57 | "stype": "example", 58 | "|xns": "Roo.doc", 59 | "xtype": "Section" 60 | } 61 | ] 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/applyLinks.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "applyLinks", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "applyLinks", 10 | "purpose": " load related objects DEPRICATED", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "applyLinks", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "", 27 | "is_optional": false, 28 | "name": "$format", 29 | "type": "", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " This is only in for compatibility ( not supported anymore )\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/databaseNickname.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "databaseNickname", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "databaseNickname", 10 | "purpose": " Return or assign the nickname of the current database", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "databaseNickname", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "The name of the current database", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "optional database name to set", 27 | "is_optional": false, 28 | "name": "", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " If you need the real database - use `$do->PDO()->dsn['database_name']`\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/fetchAllAssoc.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fetchAllAssoc", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "fetchAllAssoc", 10 | "purpose": " DEPRICATED - just use the fetchAll..", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "fetchAllAssoc", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": "", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/free.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "free", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "free", 10 | "purpose": " Deletes the result object, and resets other variables...", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "free", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " Generally it's not really needed, as result objects are stored with the\n DataObject, when the DataObject is not referenced, PHP will free the results object\n for you.\n\n Previously in DB_DataObjects this was required, as we kept a store of the resultsets seperate to\n the classes. - so when a large number of results where used, you would have to clear them up.\n This is not the case now.\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/generator.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generator", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "generator", 10 | "purpose": " create an instance of the generator.", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "generator", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "PDO_DataObject_Generator", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " class can be set by using proxy = {classname}::\n We do not really care if you have implemented it correctly....????\n you can modify the class by setting proxy to {YOUR CLASS}::{your method}\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/groupBy.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "groupBy", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "groupBy", 10 | "purpose": " Adds a group by condition (Chainable)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "groupBy", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "self", 21 | "returntype": "PDO_DataObject", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "Grouping", 27 | "is_optional": false, 28 | "name": "$group", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " NOTE : ALWAYS ENSURE ARGUMENTS ARE ESCAPED\n\n Usage:\n ```\n $object->groupBy(); \/\/reset the grouping\n $object->groupBy(\"ID DESC\");\n $object->groupBy(\"ID,age\");\n```\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/insert.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "insert", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "insert", 10 | "purpose": " Insert the current objects variables into the database", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "insert", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "when auto increment or sequence used, otherwise true on success", 21 | "returntype": "int|boolean", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " Returns the ID of the inserted element (if auto increment or sequences are used.)\n\n Usage:\n ```\n PDO_DataObject::Factory('mytable')\n ->set([ 'name' => 'test'])\n ->insert();\n ```\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | }, 48 | { 49 | "stype": "throws", 50 | "|xns": "Roo.doc", 51 | "xtype": "Section", 52 | "items": [ 53 | { 54 | "|xns": "Roo.doc", 55 | "xtype": "Para", 56 | "html": "PDO_DataObject_Exception" 57 | } 58 | ] 59 | } 60 | ] 61 | } 62 | ] 63 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/locking.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "locking", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "locking", 10 | "purpose": " Adds a locking condition (Chainable)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "locking", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "self", 21 | "returntype": "PDO_DataObject", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "set the locking condition", 27 | "is_optional": false, 28 | "name": "$locking", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " NOTE : ALWAYS ENSURE ARGUMENTS ARE ESCAPED\n\n Usage:\n ```\n $object->locking(PDO_DataObject::FOR_UPDATE);\n $object->locking(PDO_DataObject::IN_SHARE_MODE);\n $object->locking(); \/\/reset the locking\n\n ```\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/new.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "__construct", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "new PDO_DataObject", 10 | "purpose": " Constructor", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "__construct", 17 | "is_static": false, 18 | "is_constructor": true, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "either tablename or databasename\/tablename or array(database,tablename)", 27 | "is_optional": false, 28 | "name": "$cfg", 29 | "type": "array", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " This is not normally used. it's better to use factory to load extended dataObjects.\n\n Can be used to create on-the fly DataObjects. not heavily tested yet though...\n Should be used with config[proxy] = true\n\n Normally you would extend this class an fill it up with methods that relate to actions on that table\n\n usage:\n ```\n $a = new PDO_DataObject('person');\n $a = new PDO_DataObject('mydatabase\/person');\n $a = new PDO_DataObject(['mydatabase','person']);\n ```\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | } 52 | ] 53 | } 54 | ] 55 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/orderBy.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "orderBy", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "orderBy", 10 | "purpose": " Adds a order by condition (Chainable)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "orderBy", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "self", 21 | "returntype": "PDO_DataObject", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "Order by string value", 27 | "is_optional": false, 28 | "name": "$order", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " NOTE : ALWAYS ENSURE ARGUMENTS ARE ESCAPED\n\n Usage:\n ```\n $object->orderBy(); \/\/clears order by\n $object->orderBy(\"ID ASC\");\n $object->orderBy(\"ID DESC ,age ASC\");\n ```\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/pid.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pid", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "pid", 10 | "purpose": " Get the value of the primary id", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "pid", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "normally an integer, the value of the column that is the primary id", 21 | "returntype": "mixed", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " While I normally use 'id' as the PRIMARY KEY value, some database use\n {table}_id as the column name.\n\n To save a bit of typing,\n ```\n $id = $do->pid();\n ```\n\n\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | }, 48 | { 49 | "stype": "throws", 50 | "|xns": "Roo.doc", 51 | "xtype": "Section", 52 | "items": [ 53 | { 54 | "|xns": "Roo.doc", 55 | "xtype": "Para", 56 | "html": "PDO_DataObject_Exception (if the table does not have a pid or is called before insert.)" 57 | } 58 | ] 59 | } 60 | ] 61 | } 62 | ] 63 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/reset.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "reset", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "reset", 10 | "purpose": " Free the global statics - like connections, and loaded links files etc..", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "reset", 17 | "is_static": true, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " and resets other variables...\n\n Note - this is realy only for testing - calling it will likely slow down any future calls to the database\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/result.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "result", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "result", 10 | "purpose": " Gets the DB result object related to the objects active query", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "result", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "PDOStatement|false", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "result object - used to force toArray() to deliver a full range of values.", 27 | "is_optional": false, 28 | "name": "", 29 | "type": "fake", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/snapshot.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "snapshot", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "snapshot", 10 | "purpose": " snapshot the objects state (for updating later) (Chainable)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "snapshot", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "self", 21 | "returntype": "PDO_DataObject", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " When you use 'update' or save, this makes a copy, so you do not need to clone\/pass arguments to save or\n\n It is automatically called when you use `load()`\n\n Looping through results, and updating each row..\n ```\n foreach(PDO_DataObject::factory('mytable');\n ->fetchAll(23)\n as $obj) {\n\n $obj->snapshot()\n ->set([age => $obj->age + 1])\n ->save();\n }\n ```\n\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/table.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "table", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "table", 10 | "purpose": " Warning Method if using old DB_DataObjects code", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "table", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "", 21 | "returntype": "", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " It just throws an error...\n\n this has been replaced with [tableColumns](#pdo-dataobject\/tableColumns)\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | }, 48 | { 49 | "stype": "throws", 50 | "|xns": "Roo.doc", 51 | "xtype": "Section", 52 | "items": [ 53 | { 54 | "|xns": "Roo.doc", 55 | "xtype": "Para", 56 | "html": "an error always.." 57 | } 58 | ] 59 | } 60 | ] 61 | } 62 | ] 63 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/tableColumns.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tableColumns", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "tableColumns", 10 | "purpose": " get\/set an associative array of table columns", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "tableColumns", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "(associative)", 21 | "returntype": "array", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "key=>type array - if you set it to false it will clear the stored tableColumns", 27 | "is_optional": false, 28 | "name": "", 29 | "type": "array", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " Example:\n ```\n returns [\n 'id' => 129\n 'name' => 130\n ....\n ]\n Keys are the column names, values are the types\n see PDO_DataObject constants\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/tableName.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tableName", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "tableName", 10 | "purpose": " Return or assign the name of the current table", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "tableName", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "The name of the current table", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "optinal table name to set", 27 | "is_optional": false, 28 | "name": "", 29 | "type": "string", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": "", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/toSelectSQL.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "toSelectSQL", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "toSelectSQL", 10 | "purpose": " build the basic select query.", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "toSelectSQL", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "the SQL select query built from the properties.", 21 | "returntype": "string", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "flag to block recusive calling of unions..", 27 | "is_optional": false, 28 | "name": "$unions", 29 | "type": "boolean", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " Used to be called _build_select.\n\n Can be used to test the SQL generation, or build nested queries using multiple objects.\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/useIndex.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "useIndex", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "useIndex", 10 | "purpose": " Adds a using Index (Chainable)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "useIndex", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "self", 21 | "returntype": "PDO_DataObject", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [ 25 | { 26 | "desc": "index or indexes to use.", 27 | "is_optional": false, 28 | "name": "$index", 29 | "type": "array", 30 | "|xns": "Roo.doc", 31 | "xtype": "Param" 32 | } 33 | ] 34 | }, 35 | { 36 | "stype": "desc", 37 | "|xns": "Roo.doc", 38 | "xtype": "Section", 39 | "items": [ 40 | { 41 | "html": " NOTE : ALWAYS ENSURE ARGUMENTS ARE ESCAPED\n\n Usage:\n ```\n $object->useIndex(); \/\/reset the use Index\n $object->useIndex(\"some_index\");\n ```\n\n This may be mysql specific at present? - might need altering to support other databases.\n\n", 42 | "|xns": "Roo.doc", 43 | "xtype": "Para" 44 | } 45 | ] 46 | }, 47 | { 48 | "stype": "parameter", 49 | "|xns": "Roo.doc", 50 | "xtype": "Section" 51 | }, 52 | { 53 | "stype": "return", 54 | "|xns": "Roo.doc", 55 | "xtype": "Section" 56 | } 57 | ] 58 | } 59 | ] 60 | } -------------------------------------------------------------------------------- /docs/pdo-dataobject/validate.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name": "validate", 3 | "parent": "", 4 | "title": "", 5 | "permname": "", 6 | "modOrder": "001", 7 | "items": [ 8 | { 9 | "name": "validate", 10 | "purpose": " validate the values of the object (usually prior to inserting\/updating..)", 11 | "stype": "function", 12 | "|xns": "Roo.doc", 13 | "xtype": "Entry", 14 | "items": [ 15 | { 16 | "name": "validate", 17 | "is_static": false, 18 | "is_constructor": false, 19 | "memberof": "PDO_DataObject", 20 | "returndesc": "of validation results (where key=>value, value=false|object if it failed) or true (if they all succeeded)", 21 | "returntype": "array", 22 | "|xns": "Roo.doc", 23 | "xtype": "Synopsis", 24 | "items": [] 25 | }, 26 | { 27 | "stype": "desc", 28 | "|xns": "Roo.doc", 29 | "xtype": "Section", 30 | "items": [ 31 | { 32 | "html": " Uses [PDO_DataObject_Validate](#pdo-dataobject-validate\/new)\n\n", 33 | "|xns": "Roo.doc", 34 | "xtype": "Para" 35 | } 36 | ] 37 | }, 38 | { 39 | "stype": "parameter", 40 | "|xns": "Roo.doc", 41 | "xtype": "Section" 42 | }, 43 | { 44 | "stype": "return", 45 | "|xns": "Roo.doc", 46 | "xtype": "Section" 47 | } 48 | ] 49 | } 50 | ] 51 | } -------------------------------------------------------------------------------- /docs/results.bjs: -------------------------------------------------------------------------------- 1 | { 2 | "name" : "results", 3 | "parent" : "", 4 | "title" : "", 5 | "path" : "/home/alan/gitlive/PDO_DataObject/docs/results.bjs", 6 | "permname" : "", 7 | "modOrder" : "001", 8 | "strings" : { 9 | "ad8039cac05af85153c8618b5a0bbb35" : "

\nafter using fetch or fetchAll\nyour dataobject will contiain all the values returned from the database. Other than performing an update\nor outputing the properties of the object, you can also call a number of methods\n

\n