codeigniter_vender 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +2 -0
- data/MIT-LICENSE +20 -0
- data/README +40 -0
- data/Rakefile +18 -0
- data/VERSION +1 -0
- data/codeigniter_vender.gemspec +389 -0
- data/generators/ci_app/USAGE +8 -0
- data/generators/ci_app/ci_app_generator.rb +12 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/index.php +118 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/license.txt +52 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/autoload.php +116 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/config.php +329 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/constants.php +41 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/database.php +55 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/doctypes.php +15 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/hooks.php +16 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/mimes.php +105 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/routes.php +48 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/smileys.php +66 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/user_agents.php +175 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/controllers/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/controllers/welcome.php +17 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_404.php +34 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_db.php +34 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_general.php +34 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_php.php +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/helpers/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/hooks/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/language/english/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/libraries/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/models/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/views/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/views/welcome_message.php +62 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/cache/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Base4.php +69 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Base5.php +56 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/CodeIgniter.php +280 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Common.php +421 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Compat.php +93 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB.php +146 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_active_rec.php +1820 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_cache.php +195 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_driver.php +1366 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_forge.php +375 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_result.php +342 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_utility.php +389 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_driver.php +667 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_forge.php +248 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_result.php +169 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_utility.php +123 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_driver.php +670 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_forge.php +254 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_result.php +169 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_utility.php +245 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_driver.php +671 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_forge.php +254 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_result.php +169 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_utility.php +123 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_driver.php +780 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_forge.php +248 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_result.php +249 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_utility.php +122 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_driver.php +639 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_forge.php +266 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_result.php +228 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_utility.php +148 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_driver.php +684 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_forge.php +248 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_result.php +169 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_utility.php +124 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_driver.php +657 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_forge.php +265 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_result.php +179 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_utility.php +141 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/fonts/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/fonts/texb.ttf +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/array_helper.php +78 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/compatibility_helper.php +498 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/cookie_helper.php +144 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/date_helper.php +611 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/directory_helper.php +84 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/download_helper.php +100 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/email_helper.php +62 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/file_helper.php +464 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/form_helper.php +1025 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/html_helper.php +416 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/inflector_helper.php +171 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/language_helper.php +58 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/number_helper.php +75 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/path_helper.php +72 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/security_helper.php +126 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/smiley_helper.php +273 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/string_helper.php +273 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/text_helper.php +462 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/typography_helper.php +71 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/url_helper.php +593 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/xml_helper.php +62 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/calendar_lang.php +51 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/date_lang.php +60 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/db_lang.php +28 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/email_lang.php +24 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/form_validation_lang.php +24 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/ftp_lang.php +17 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/imglib_lang.php +24 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/number_lang.php +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/profiler_lang.php +19 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/scaffolding_lang.php +17 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/unit_test_lang.php +24 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/upload_lang.php +22 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/validation_lang.php +24 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Benchmark.php +113 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Calendar.php +477 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Cart.php +550 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Config.php +244 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Controller.php +127 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Email.php +2041 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Encrypt.php +484 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Exceptions.php +174 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Form_validation.php +1278 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Ftp.php +618 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Hooks.php +226 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Image_lib.php +1544 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Input.php +1067 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Language.php +123 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Loader.php +1085 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Log.php +117 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Model.php +83 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Output.php +409 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Pagination.php +244 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Parser.php +173 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Profiler.php +392 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Router.php +389 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Session.php +758 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Sha1.php +251 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Table.php +440 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Trackback.php +547 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Typography.php +406 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/URI.php +586 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Unit_test.php +347 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Upload.php +970 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/User_agent.php +502 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Validation.php +875 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Xmlrpc.php +1421 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Xmlrpcs.php +536 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Zip.php +359 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/logs/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/captcha_pi.php +356 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/js_calendar_pi.php +629 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/Scaffolding.php +291 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/background.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/logo.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/add.php +32 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/delete.php +9 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/edit.php +33 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/footer.php +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/header.php +29 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/index.html +10 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/no_data.php +8 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/stylesheet.css +143 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/view.php +27 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/changelog.html +1080 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/active_record.html +757 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/caching.html +220 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/call_function.html +118 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/configuration.html +157 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/connecting.html +186 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/examples.html +217 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/fields.html +163 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/forge.html +234 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/helpers.html +151 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/index.html +99 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/queries.html +153 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/results.html +238 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/table_data.html +113 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/transactions.html +200 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/utilities.html +295 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/doc_style/index.html +86 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/doc_style/template.html +128 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/alternative_php.html +147 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/ancillary_classes.html +117 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/autoloader.html +101 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/caching.html +115 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/common_functions.html +119 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/controllers.html +385 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/core_classes.html +185 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/creating_libraries.html +298 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/credits.html +86 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/errors.html +138 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/helpers.html +185 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/hooks.html +167 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/libraries.html +94 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/managing_apps.html +133 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/models.html +251 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/plugins.html +127 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/profiling.html +104 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/quick_reference.html +77 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/requirements.html +82 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/reserved_names.html +156 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/routing.html +176 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/scaffolding.html +147 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/security.html +153 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/styleguide.html +687 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/urls.html +151 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/views.html +274 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/array_helper.html +119 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/compatibility_helper.html +118 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/cookie_helper.html +147 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/date_helper.html +408 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/directory_helper.html +143 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/download_helper.html +112 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/email_helper.html +102 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/file_helper.html +178 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/form_helper.html +484 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/html_helper.html +385 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/inflector_helper.html +151 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/language_helper.html +98 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/number_helper.html +107 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/path_helper.html +106 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/security_helper.html +125 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/smiley_helper.html +215 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/string_helper.html +176 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/text_helper.html +192 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/typography_helper.html +112 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/url_helper.html +289 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/xml_helper.html +105 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/appflowchart.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/arrow.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_logo.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_logo_flame.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_quick_ref.png +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_helper_reference.pdf +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_helper_reference.png +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_library_reference.pdf +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_library_reference.png +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/file.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/folder.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_bg_darker.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_separator_darker.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_toggle_darker.jpg +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/smile.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/transparent.gif +0 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/index.html +99 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/downloads.html +105 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/index.html +97 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/troubleshooting.html +90 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_120.html +92 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_130.html +203 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_131.html +102 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_132.html +100 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_133.html +112 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_140.html +145 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_141.html +148 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_150.html +178 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_152.html +111 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_153.html +100 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_154.html +116 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_160.html +125 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_161.html +98 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_162.html +106 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_163.html +99 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_170.html +121 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_171.html +98 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_172.html +105 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_b11.html +144 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrading.html +101 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/benchmark.html +198 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/calendar.html +249 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/cart.html +346 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/config.html +181 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/email.html +307 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/encryption.html +182 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/file_uploading.html +451 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/form_validation.html +1221 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/ftp.html +303 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/image_lib.html +666 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/input.html +231 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/language.html +137 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/loader.html +214 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/output.html +145 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/pagination.html +218 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/parser.html +208 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/sessions.html +311 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/table.html +292 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/trackback.html +246 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/typography.html +160 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/unit_testing.html +205 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/uri.html +252 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/user_agent.html +201 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/validation.html +740 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/xmlrpc.html +517 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/zip.html +278 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/license.html +107 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/hacks.txt +9 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/moo.fx.js +119 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/moo.fx.pack.js +241 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/nav.js +139 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/prototype.lite.js +127 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/user_guide_menu.js +4 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/appflow.html +95 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/at_a_glance.html +172 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/cheatsheets.html +83 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/features.html +120 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/getting_started.html +92 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/goals.html +98 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/index.html +84 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/mvc.html +100 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/toc.html +209 -0
- data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/userguide.css +406 -0
- data/generators/ci_app/templates/README +1 -0
- data/generators/ci_controller/USAGE +2 -0
- data/generators/ci_controller/ci_controller_generator.rb +11 -0
- data/generators/ci_controller/templates/ci_controller.php.erb +15 -0
- data/generators/ci_controller/templates/ci_view.php.erb +8 -0
- data/generators/ci_layout/USAGE +2 -0
- data/generators/ci_layout/ci_layout_generator.rb +24 -0
- data/generators/ci_layout/templates/application_layout.php.erb +19 -0
- data/generators/ci_model/USAGE +2 -0
- data/generators/ci_model/ci_model_generator.rb +42 -0
- data/generators/ci_model/templates/ci_model.php.erb +15 -0
- data/generators/ci_model/templates/model.rb +5 -0
- data/generators/ci_model/templates/model_migration.rb.erb +16 -0
- data/init.rb +1 -0
- data/install.rb +1 -0
- data/lib/codeigniter_vender.rb +1 -0
- data/lib/tasks/app.rake +8 -0
- data/test/codeigniter_vender_test.rb +8 -0
- data/test/test_helper.rb +3 -0
- data/uninstall.rb +1 -0
- metadata +411 -0
@@ -0,0 +1,517 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
3
|
+
<head>
|
4
|
+
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>XML-RPC and XML-RPC Server Classes : CodeIgniter User Guide</title>
|
7
|
+
|
8
|
+
<style type='text/css' media='all'>@import url('../userguide.css');</style>
|
9
|
+
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
|
10
|
+
|
11
|
+
<script type="text/javascript" src="../nav/nav.js"></script>
|
12
|
+
<script type="text/javascript" src="../nav/prototype.lite.js"></script>
|
13
|
+
<script type="text/javascript" src="../nav/moo.fx.js"></script>
|
14
|
+
<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
|
15
|
+
|
16
|
+
<meta http-equiv='expires' content='-1' />
|
17
|
+
<meta http-equiv= 'pragma' content='no-cache' />
|
18
|
+
<meta name='robots' content='all' />
|
19
|
+
<meta name='author' content='ExpressionEngine Dev Team' />
|
20
|
+
<meta name='description' content='CodeIgniter User Guide' />
|
21
|
+
|
22
|
+
</head>
|
23
|
+
<body>
|
24
|
+
|
25
|
+
<!-- START NAVIGATION -->
|
26
|
+
<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
|
27
|
+
<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
|
28
|
+
<div id="masthead">
|
29
|
+
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
30
|
+
<tr>
|
31
|
+
<td><h1>CodeIgniter User Guide Version 1.7.2</h1></td>
|
32
|
+
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
|
33
|
+
</tr>
|
34
|
+
</table>
|
35
|
+
</div>
|
36
|
+
<!-- END NAVIGATION -->
|
37
|
+
|
38
|
+
|
39
|
+
<!-- START BREADCRUMB -->
|
40
|
+
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
41
|
+
<tr>
|
42
|
+
<td id="breadcrumb">
|
43
|
+
<a href="http://codeigniter.com/">CodeIgniter Home</a> ›
|
44
|
+
<a href="../index.html">User Guide Home</a> ›
|
45
|
+
XML-RPC and XML-RPC Server Classes
|
46
|
+
</td>
|
47
|
+
<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>
|
48
|
+
</tr>
|
49
|
+
</table>
|
50
|
+
<!-- END BREADCRUMB -->
|
51
|
+
|
52
|
+
<br clear="all" />
|
53
|
+
|
54
|
+
|
55
|
+
<!-- START CONTENT -->
|
56
|
+
<div id="content">
|
57
|
+
|
58
|
+
|
59
|
+
<h1>XML-RPC and XML-RPC Server Classes</h1>
|
60
|
+
|
61
|
+
|
62
|
+
<p>CodeIgniter's XML-RPC classes permit you to send requests to another server, or set up
|
63
|
+
your own XML-RPC server to receive requests.</p>
|
64
|
+
|
65
|
+
|
66
|
+
<h2>What is XML-RPC?</h2>
|
67
|
+
|
68
|
+
<p>Quite simply it is a way for two computers to communicate over the internet using XML.
|
69
|
+
One computer, which we will call the <dfn>client</dfn>, sends an XML-RPC <strong>request</strong> to
|
70
|
+
another computer, which we will call the <dfn>server</dfn>. Once the server receives and processes the request it
|
71
|
+
will send back a <strong>response</strong> to the client.</p>
|
72
|
+
|
73
|
+
<p>For example, using the MetaWeblog API, an XML-RPC Client (usually a desktop publishing tool) will
|
74
|
+
send a request to an XML-RPC Server running on your site. This request might be a new weblog entry
|
75
|
+
being sent for publication, or it could be a request for an existing entry for editing.
|
76
|
+
|
77
|
+
When the XML-RPC Server receives this request it will examine it to determine which class/method should be called to process the request.
|
78
|
+
Once processed, the server will then send back a response message.</p>
|
79
|
+
|
80
|
+
<p>For detailed specifications, you can visit the <a href="http://www.xmlrpc.com/">XML-RPC</a> site.</p>
|
81
|
+
|
82
|
+
<h2>Initializing the Class</h2>
|
83
|
+
|
84
|
+
<p>Like most other classes in CodeIgniter, the XML-RPC and XML-RPCS classes are initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
|
85
|
+
|
86
|
+
<p>To load the XML-RPC class you will use:</p>
|
87
|
+
<code>$this->load->library('xmlrpc');</code>
|
88
|
+
<p>Once loaded, the xml-rpc library object will be available using: <dfn>$this->xmlrpc</dfn></p>
|
89
|
+
|
90
|
+
<p>To load the XML-RPC Server class you will use:</p>
|
91
|
+
<code>
|
92
|
+
$this->load->library('xmlrpc');<br />
|
93
|
+
$this->load->library('xmlrpcs');
|
94
|
+
</code>
|
95
|
+
<p>Once loaded, the xml-rpcs library object will be available using: <dfn>$this->xmlrpcs</dfn></p>
|
96
|
+
|
97
|
+
<p class="important"><strong>Note:</strong> When using the XML-RPC Server class you must load BOTH the XML-RPC class and the XML-RPC Server class.</p>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<h2>Sending XML-RPC Requests</h2>
|
102
|
+
|
103
|
+
<p>To send a request to an XML-RPC server you must specify the following information:</p>
|
104
|
+
|
105
|
+
<ul>
|
106
|
+
<li>The URL of the server</li>
|
107
|
+
<li>The method on the server you wish to call</li>
|
108
|
+
<li>The <em>request</em> data (explained below).</li>
|
109
|
+
</ul>
|
110
|
+
|
111
|
+
<p>Here is a basic example that sends a simple Weblogs.com ping to the <a href="http://pingomatic.com/">Ping-o-Matic</a></p>
|
112
|
+
|
113
|
+
|
114
|
+
<code>$this->load->library('xmlrpc');<br />
|
115
|
+
<br />
|
116
|
+
$this->xmlrpc->server('http://rpc.pingomatic.com/', 80);<br />
|
117
|
+
$this->xmlrpc->method('weblogUpdates.ping');<br />
|
118
|
+
|
119
|
+
<br />
|
120
|
+
$request = array('My Photoblog', 'http://www.my-site.com/photoblog/');<br />
|
121
|
+
$this->xmlrpc->request($request);<br />
|
122
|
+
<br />
|
123
|
+
if ( ! $this->xmlrpc->send_request())<br />
|
124
|
+
{<br />
|
125
|
+
echo $this->xmlrpc->display_error();<br />
|
126
|
+
}</code>
|
127
|
+
|
128
|
+
<h3>Explanation</h3>
|
129
|
+
|
130
|
+
<p>The above code initializes the XML-RPC class, sets the server URL and method to be called (weblogUpdates.ping). The
|
131
|
+
request (in this case, the title and URL of your site) is placed into an array for transportation, and
|
132
|
+
compiled using the request() function.
|
133
|
+
Lastly, the full request is sent. If the <dfn>send_request()</dfn> method returns false we will display the error message
|
134
|
+
sent back from the XML-RPC Server.</p>
|
135
|
+
|
136
|
+
<h2>Anatomy of a Request</h2>
|
137
|
+
|
138
|
+
<p>An XML-RPC <dfn>request</dfn> is simply the data you are sending to the XML-RPC server. Each piece of data in a request
|
139
|
+
is referred to as a <dfn>request parameter</dfn>. The above example has two parameters:
|
140
|
+
The URL and title of your site. When the XML-RPC server receives your request, it will look for parameters it requires.</p>
|
141
|
+
|
142
|
+
<p>Request parameters must be placed into an array for transportation, and each parameter can be one
|
143
|
+
of seven data types (strings, numbers, dates, etc.). If your parameters are something other than strings
|
144
|
+
you will have to include the data type in the request array.</p>
|
145
|
+
|
146
|
+
<p>Here is an example of a simple array with three parameters:</p>
|
147
|
+
|
148
|
+
<code>$request = array('John', 'Doe', 'www.some-site.com');<br />
|
149
|
+
$this->xmlrpc->request($request);</code>
|
150
|
+
|
151
|
+
<p>If you use data types other than strings, or if you have several different data types, you will place
|
152
|
+
each parameter into its own array, with the data type in the second position:</p>
|
153
|
+
|
154
|
+
<code>
|
155
|
+
$request = array (<br />
|
156
|
+
array('John', 'string'),<br />
|
157
|
+
array('Doe', 'string'),<br />
|
158
|
+
array(FALSE, 'boolean'),<br />
|
159
|
+
array(12345, 'int')<br />
|
160
|
+
);
|
161
|
+
<br />
|
162
|
+
$this->xmlrpc->request($request);</code>
|
163
|
+
|
164
|
+
The <a href="#datatypes">Data Types</a> section below has a full list of data types.
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
<h2>Creating an XML-RPC Server</h2>
|
169
|
+
|
170
|
+
<p>An XML-RPC Server acts as a traffic cop of sorts, waiting for incoming requests and redirecting them to the
|
171
|
+
appropriate functions for processing.</p>
|
172
|
+
|
173
|
+
<p>To create your own XML-RPC server involves initializing the XML-RPC Server class in your controller where you expect the incoming
|
174
|
+
request to appear, then setting up an array with mapping instructions so that incoming requests can be sent to the appropriate
|
175
|
+
class and method for processing.</p>
|
176
|
+
|
177
|
+
<p>Here is an example to illustrate:</p>
|
178
|
+
|
179
|
+
<code>
|
180
|
+
$this->load->library('xmlrpc');<br />
|
181
|
+
$this->load->library('xmlrpcs');<br />
|
182
|
+
<br />
|
183
|
+
$config['functions']['<var>new_post</var>'] = array('function' => '<dfn>My_blog.new_entry</dfn>'),<br />
|
184
|
+
$config['functions']['<var>update_post</var>'] = array('function' => '<dfn>My_blog.update_entry</dfn>');<br />
|
185
|
+
$config['object'] = $this;<br />
|
186
|
+
<br />
|
187
|
+
$this->xmlrpcs->initialize($config);<br />
|
188
|
+
$this->xmlrpcs->serve();</code>
|
189
|
+
|
190
|
+
<p>The above example contains an array specifying two method requests that the Server allows.
|
191
|
+
The allowed methods are on the left side of the array. When either of those are received, they will be mapped to the class and method on the right.</p>
|
192
|
+
|
193
|
+
<p>The '<var>object</var>' key is a special key that you pass an instantiated class object with, which is necessary when the method you are mapping to is not
|
194
|
+
part of the CodeIgniter super object.</p>
|
195
|
+
|
196
|
+
<p>In other words, if an XML-RPC Client sends a request for the <var>new_post</var> method, your
|
197
|
+
server will load the <dfn>My_blog</dfn> class and call the <dfn>new_entry</dfn> function.
|
198
|
+
If the request is for the <var>update_post</var> method, your
|
199
|
+
server will load the <dfn>My_blog</dfn> class and call the <dfn>update_entry</dfn> function.</p>
|
200
|
+
|
201
|
+
<p>The function names in the above example are arbitrary. You'll decide what they should be called on your server,
|
202
|
+
or if you are using standardized APIs, like the Blogger or MetaWeblog API, you'll use their function names.</p>
|
203
|
+
|
204
|
+
<h2>Processing Server Requests</h2>
|
205
|
+
|
206
|
+
<p>When the XML-RPC Server receives a request and loads the class/method for processing, it will pass
|
207
|
+
an object to that method containing the data sent by the client.</p>
|
208
|
+
|
209
|
+
<p>Using the above example, if the <var>new_post</var> method is requested, the server will expect a class
|
210
|
+
to exist with this prototype:</p>
|
211
|
+
|
212
|
+
<code>class <kbd>My_blog</kbd> extends Controller {<br />
|
213
|
+
<br />
|
214
|
+
function <kbd>new_post</kbd>(<var>$request</var>)<br />
|
215
|
+
{<br />
|
216
|
+
<br />
|
217
|
+
}<br />
|
218
|
+
}
|
219
|
+
</code>
|
220
|
+
|
221
|
+
<p>The <var>$request</var> variable is an object compiled by the Server, which contains the data sent by the XML-RPC Client.
|
222
|
+
Using this object you will have access to the <em>request parameters</em> enabling you to process the request. When
|
223
|
+
you are done you will send a <dfn>Response</dfn> back to the Client.</p>
|
224
|
+
|
225
|
+
<p>Below is a real-world example, using the Blogger API. One of the methods in the Blogger API is <dfn>getUserInfo()</dfn>.
|
226
|
+
Using this method, an XML-RPC Client can send the Server a username and password, in return the Server sends
|
227
|
+
back information about that particular user (nickname, user ID, email address, etc.). Here is how the processing
|
228
|
+
function might look:</p>
|
229
|
+
|
230
|
+
|
231
|
+
<code>class <kbd>My_blog</kbd> extends Controller {<br />
|
232
|
+
<br />
|
233
|
+
function <kbd>getUserInfo</kbd>(<var>$request</var>)<br />
|
234
|
+
{<br />
|
235
|
+
|
236
|
+
$username = 'smitty';<br />
|
237
|
+
$password = 'secretsmittypass';<br /><br />
|
238
|
+
|
239
|
+
$this->load->library('xmlrpc');<br />
|
240
|
+
<br />
|
241
|
+
$parameters = $request->output_parameters();<br />
|
242
|
+
<br />
|
243
|
+
if ($parameters['1'] != $username AND $parameters['2'] != $password)<br />
|
244
|
+
{<br />
|
245
|
+
return $this->xmlrpc->send_error_message('100', 'Invalid Access');<br />
|
246
|
+
}<br />
|
247
|
+
<br />
|
248
|
+
$response = array(array('nickname' => array('Smitty','string'),<br />
|
249
|
+
'userid' => array('99','string'),<br />
|
250
|
+
'url' => array('http://yoursite.com','string'),<br />
|
251
|
+
'email' => array('jsmith@yoursite.com','string'),<br />
|
252
|
+
'lastname' => array('Smith','string'),<br />
|
253
|
+
'firstname' => array('John','string')<br />
|
254
|
+
),<br />
|
255
|
+
'struct');<br />
|
256
|
+
<br />
|
257
|
+
return $this->xmlrpc->send_response($response);<br />
|
258
|
+
}<br />
|
259
|
+
}
|
260
|
+
</code>
|
261
|
+
|
262
|
+
<h3>Notes:</h3>
|
263
|
+
<p>The <dfn>output_parameters()</dfn> function retrieves an indexed array corresponding to the request parameters sent by the client.
|
264
|
+
In the above example, the output parameters will be the username and password.</p>
|
265
|
+
|
266
|
+
<p>If the username and password sent by the client were not valid, and error message is returned using <dfn>send_error_message()</dfn>.</p>
|
267
|
+
|
268
|
+
<p>If the operation was successful, the client will be sent back a response array containing the user's info.</p>
|
269
|
+
|
270
|
+
|
271
|
+
<h2>Formatting a Response</h2>
|
272
|
+
|
273
|
+
<p>Similar to <em>Requests</em>, <em>Responses</em> must be formatted as an array. However, unlike requests, a response is an array
|
274
|
+
<strong>that contains a single item</strong>. This item can be an array with several additional arrays, but there
|
275
|
+
can be only one primary array index. In other words, the basic prototype is this:</p>
|
276
|
+
|
277
|
+
<code>$response = array('Response data', 'array');</code>
|
278
|
+
|
279
|
+
<p>Responses, however, usually contain multiple pieces of information. In order to accomplish this we must put the response into its own
|
280
|
+
array so that the primary array continues to contain a single piece of data. Here's an example showing how this might be accomplished:</p>
|
281
|
+
|
282
|
+
<code>
|
283
|
+
$response = array (<br />
|
284
|
+
array(<br />
|
285
|
+
'first_name' => array('John', 'string'),<br />
|
286
|
+
'last_name' => array('Doe', 'string'),<br />
|
287
|
+
'member_id' => array(123435, 'int'),<br />
|
288
|
+
'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),<br />
|
289
|
+
),<br />
|
290
|
+
'struct'<br />
|
291
|
+
);
|
292
|
+
</code>
|
293
|
+
|
294
|
+
<p class="important">Notice that the above array is formatted as a <dfn>struct</dfn>. This is the most common data type for responses.</p>
|
295
|
+
|
296
|
+
<p>As with Requests, a response can be one of the seven data types listed in the <a href="#datatypes">Data Types</a> section.</p>
|
297
|
+
|
298
|
+
|
299
|
+
<h2>Sending an Error Response</h2>
|
300
|
+
|
301
|
+
<p>If you need to send the client an error response you will use the following:</p>
|
302
|
+
|
303
|
+
<code>return $this->xmlrpc->send_error_message('123', 'Requested data not available');</code>
|
304
|
+
|
305
|
+
<p>The first parameter is the error number while the second parameter is the error message.</p>
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
<h2>Creating Your Own Client and Server</h2>
|
313
|
+
|
314
|
+
<p>To help you understand everything we've covered thus far, let's create a couple controllers that act as
|
315
|
+
XML-RPC Client and Server. You'll use the Client to send a request to the Server and receive a response.</p>
|
316
|
+
|
317
|
+
<h3>The Client</h3>
|
318
|
+
|
319
|
+
<p>Using a text editor, create a controller called <dfn>xmlrpc_client.php</dfn>.
|
320
|
+
In it, place this code and save it to your <samp>applications/controllers/</samp> folder:</p>
|
321
|
+
|
322
|
+
<textarea class="textarea" style="width:100%" cols="50" rows="32"><?php
|
323
|
+
|
324
|
+
class Xmlrpc_client extends Controller {
|
325
|
+
|
326
|
+
function index()
|
327
|
+
{
|
328
|
+
$this->load->helper('url');
|
329
|
+
$server_url = site_url('xmlrpc_server');
|
330
|
+
|
331
|
+
$this->load->library('xmlrpc');
|
332
|
+
|
333
|
+
$this->xmlrpc->server($server_url, 80);
|
334
|
+
$this->xmlrpc->method('Greetings');
|
335
|
+
|
336
|
+
$request = array('How is it going?');
|
337
|
+
$this->xmlrpc->request($request);
|
338
|
+
|
339
|
+
if ( ! $this->xmlrpc->send_request())
|
340
|
+
{
|
341
|
+
echo $this->xmlrpc->display_error();
|
342
|
+
}
|
343
|
+
else
|
344
|
+
{
|
345
|
+
echo '<pre>';
|
346
|
+
print_r($this->xmlrpc->display_response());
|
347
|
+
echo '</pre>';
|
348
|
+
}
|
349
|
+
}
|
350
|
+
}
|
351
|
+
?></textarea>
|
352
|
+
|
353
|
+
<p>Note: In the above code we are using a "url helper". You can find more information in the <a href="../general/helpers.html">Helpers Functions</a> page.</p>
|
354
|
+
|
355
|
+
<h3>The Server</h3>
|
356
|
+
|
357
|
+
<p>Using a text editor, create a controller called <dfn>xmlrpc_server.php</dfn>.
|
358
|
+
In it, place this code and save it to your <samp>applications/controllers/</samp> folder:</p>
|
359
|
+
|
360
|
+
<textarea class="textarea" style="width:100%" cols="50" rows="30"><?php
|
361
|
+
|
362
|
+
class Xmlrpc_server extends Controller {
|
363
|
+
|
364
|
+
function index()
|
365
|
+
{
|
366
|
+
$this->load->library('xmlrpc');
|
367
|
+
$this->load->library('xmlrpcs');
|
368
|
+
|
369
|
+
$config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process');
|
370
|
+
|
371
|
+
$this->xmlrpcs->initialize($config);
|
372
|
+
$this->xmlrpcs->serve();
|
373
|
+
}
|
374
|
+
|
375
|
+
|
376
|
+
function process($request)
|
377
|
+
{
|
378
|
+
$parameters = $request->output_parameters();
|
379
|
+
|
380
|
+
$response = array(
|
381
|
+
array(
|
382
|
+
'you_said' => $parameters['0'],
|
383
|
+
'i_respond' => 'Not bad at all.'),
|
384
|
+
'struct');
|
385
|
+
|
386
|
+
return $this->xmlrpc->send_response($response);
|
387
|
+
}
|
388
|
+
}
|
389
|
+
?></textarea>
|
390
|
+
|
391
|
+
<h3>Try it!</h3>
|
392
|
+
|
393
|
+
<p>Now visit the your site using a URL similar to this:</p>
|
394
|
+
<code>example.com/index.php/<var>xmlrpc_client</var>/</code>
|
395
|
+
|
396
|
+
<p>You should now see the message you sent to the server, and its response back to you.</p>
|
397
|
+
|
398
|
+
<p>The client you created sends a message ("How's is going?") to the server, along with a request for the "Greetings" method.
|
399
|
+
The Server receives the request and maps it to the "process" function, where a response is sent back.</p>
|
400
|
+
|
401
|
+
<h2>Using Associative Arrays In a Request Parameter</h2>
|
402
|
+
|
403
|
+
<p>If you wish to use an associative array in your method parameters you will need to use a struct datatype:</p>
|
404
|
+
|
405
|
+
<code>$request = array(<br />
|
406
|
+
array(<br />
|
407
|
+
// Param 0<br />
|
408
|
+
array(<br />
|
409
|
+
'name'=>'John'<br />
|
410
|
+
),<br />
|
411
|
+
'struct'<br />
|
412
|
+
),<br />
|
413
|
+
array(<br />
|
414
|
+
// Param 1<br />
|
415
|
+
array(<br />
|
416
|
+
'size'=>'large',<br />
|
417
|
+
'shape'=>'round'<br />
|
418
|
+
),<br />
|
419
|
+
'struct'<br />
|
420
|
+
)<br />
|
421
|
+
);<br />
|
422
|
+
$this->xmlrpc->request($request);</code>
|
423
|
+
|
424
|
+
<p>You can retrieve the associative array when processing the request in the Server.</p>
|
425
|
+
|
426
|
+
<code>$parameters = $request->output_parameters();<br />
|
427
|
+
$name = $parameters['0']['name'];<br />
|
428
|
+
$size = $parameters['1']['size'];<br />
|
429
|
+
$size = $parameters['1']['shape']; </code>
|
430
|
+
|
431
|
+
<h1>XML-RPC Function Reference</h1>
|
432
|
+
|
433
|
+
<h2>$this->xmlrpc->server()</h2>
|
434
|
+
<p>Sets the URL and port number of the server to which a request is to be sent:</p>
|
435
|
+
<code>$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);</code>
|
436
|
+
|
437
|
+
<h2>$this->xmlrpc->timeout()</h2>
|
438
|
+
<p>Set a time out period (in seconds) after which the request will be canceled:</p>
|
439
|
+
<code>$this->xmlrpc->timeout(6);</code>
|
440
|
+
|
441
|
+
<h2>$this->xmlrpc->method()</h2>
|
442
|
+
<p>Sets the method that will be requested from the XML-RPC server:</p>
|
443
|
+
<code>$this->xmlrpc->method('<var>method</var>');</code>
|
444
|
+
|
445
|
+
<p>Where <var>method</var> is the name of the method.</p>
|
446
|
+
|
447
|
+
<h2>$this->xmlrpc->request()</h2>
|
448
|
+
<p>Takes an array of data and builds request to be sent to XML-RPC server:</p>
|
449
|
+
<code>$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');<br />
|
450
|
+
$this->xmlrpc->request($request);</code>
|
451
|
+
|
452
|
+
<h2>$this->xmlrpc->send_request()</h2>
|
453
|
+
<p>The request sending function. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally.</p>
|
454
|
+
|
455
|
+
<h2>$this->xmlrpc->set_debug(TRUE);</h2>
|
456
|
+
<p>Enables debugging, which will display a variety of information and error data helpful during development.</p>
|
457
|
+
|
458
|
+
|
459
|
+
<h2>$this->xmlrpc->display_error()</h2>
|
460
|
+
<p>Returns an error message as a string if your request failed for some reason.</p>
|
461
|
+
<code>echo $this->xmlrpc->display_error();</code>
|
462
|
+
|
463
|
+
<h2>$this->xmlrpc->display_response()</h2>
|
464
|
+
<p>Returns the response from the remote server once request is received. The response will typically be an associative array.</p>
|
465
|
+
<code>$this->xmlrpc->display_response();</code>
|
466
|
+
|
467
|
+
<h2>$this->xmlrpc->send_error_message()</h2>
|
468
|
+
<p>This function lets you send an error message from your server to the client. First parameter is the error number while the second parameter
|
469
|
+
is the error message.</p>
|
470
|
+
<code>return $this->xmlrpc->send_error_message('123', 'Requested data not available');</code>
|
471
|
+
|
472
|
+
<h2>$this->xmlrpc->send_response()</h2>
|
473
|
+
<p>Lets you send the response from your server to the client. An array of valid data values must be sent with this method.</p>
|
474
|
+
<code>$response = array(<br />
|
475
|
+
array(<br />
|
476
|
+
'flerror' => array(FALSE, 'boolean'),<br />
|
477
|
+
'message' => "Thanks for the ping!")<br />
|
478
|
+
)<br />
|
479
|
+
'struct');<br />
|
480
|
+
return $this->xmlrpc->send_response($response);</code>
|
481
|
+
|
482
|
+
|
483
|
+
<a name="datatypes"></a>
|
484
|
+
<h2>Data Types</h2>
|
485
|
+
|
486
|
+
<p>According to the <a href="http://www.xmlrpc.com/spec">XML-RPC spec</a> there are seven types
|
487
|
+
of values that you can send via XML-RPC:</p>
|
488
|
+
|
489
|
+
<ul>
|
490
|
+
<li><em>int</em> or <em>i4</em></li>
|
491
|
+
<li><em>boolean</em></li>
|
492
|
+
<li><em>string</em></li>
|
493
|
+
<li><em>double</em></li>
|
494
|
+
<li><em>dateTime.iso8601</em></li>
|
495
|
+
<li><em>base64</em></li>
|
496
|
+
<li><em>struct</em> (contains array of values)</li>
|
497
|
+
<li><em>array</em> (contains array of values)</li>
|
498
|
+
</ul>
|
499
|
+
|
500
|
+
|
501
|
+
</div>
|
502
|
+
<!-- END CONTENT -->
|
503
|
+
|
504
|
+
|
505
|
+
<div id="footer">
|
506
|
+
<p>
|
507
|
+
Previous Topic: <a href="user_agent.html">User Agent Class</a>
|
508
|
+
·
|
509
|
+
<a href="#top">Top of Page</a> ·
|
510
|
+
<a href="../index.html">User Guide Home</a> ·
|
511
|
+
Next Topic: <a href="zip.html">Zip Encoding Class</a>
|
512
|
+
</p>
|
513
|
+
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2010 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
|
514
|
+
</div>
|
515
|
+
|
516
|
+
</body>
|
517
|
+
</html>
|