Download the PHP package rah/rah_external_output without Composer
On this page you can find all versions of the php package rah/rah_external_output. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rah/rah_external_output
More information about rah/rah_external_output
Files in rah/rah_external_output
Package rah_external_output
Short Description Content-type snippets plugin for Textpattern
License GPL-2.0
Homepage http://rahforum.biz/plugins/rah_external_output
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rah_external_output
h1. rah_external_output
"Download":https://github.com/gocom/rah_external_output/releases | "Packagist":https://packagist.org/packages/rah/rah_external_output | "Twitter":http://twitter.com/gocom | "GitHub":https://github.com/gocom/rah_external_output | "Support forum":http://forum.textpattern.com/viewtopic.php?id=30664 | "Donate":http://rahforum.biz/donate/rah_external_output
Rah_external_output is a "Textpattern":http://textpattern.com plugin that can be used create custom content-type snippets. These snippets can be requested with a publicly accessible URL, and used as pages or to provide site's content over in form of JSON or XML to JavaScript or across domains.
While these snippets can act as pages, they are independent from Textpattern's normal content model. Snippets won't require or overpopulate "page templates":http://textpattern.net/wiki/index.php?title=Pages or "sections":http://textpattern.net/wiki/index.php?title=Sections.
This makes the plugin ideal for generating various publicly accessible snippets, including XML feeds or JavaScript Object Notations that can be then used to feed site's content to JavaScript applications, build application layers or to transmit content across domains.
Rah_external_output uses Textpattern's "form partials":http://textpattern.net/wiki/index.php?title=Forms to power its snippets. A form partial that's name is prefixed with a @raheo@ can be accessed directly with a URL, creating its own, independent, page. The term external directly refers to separateness and independency from sections and page templates while still serving client-side content.
h2. List of features
- "Form partials":http://textpattern.net/wiki/index.php?title=Forms prefixed with a @raheo@ can be requested, and their output accessed, directly using a public URL.
- In addition to normal form partials, these special forms, snippets, can contain HTTP header lines. Lines at the beginning of the form staring with a semicolon are treated as headers.
- Form partials can be served using different content-type by appending file extension to the name.
h2. Requirements
Rah_external_output's minimum requirements:
- Textpattern 4.4.1 or newer.
- PHP 5.2.0 or newer.
h2. Install
Using "Composer":http://getcomposer.org:
bc. $ composer require rah/rah_external_output:*
Or "download":https://github.com/gocom/rah_external_output/releases a plugin package.
h2. Basics
Rah_external_output treats any misc type "form partial":http://textpattern.net/wiki/index.php?title=Forms that name us prefixed with a @raheo@ prefix as a "external" content-type snippet. These special prefixed forms can be accessed using a public callback URL. This URL follows the pattern:
bc. http://example.com/?rah_external_output=FormNameWithoutPrefix
Where @example.com@ is the site's URL and @FormNameWithoutPrefix@ is the form's name excluding the prefix. The above URL would output a misc form named as @rah_eo_FormNameWithoutPrefix@.
h2. Creating your first snippet
Creating a new rah_external_output's custom form, a snippet, would follow the same steps as "any other form":http://textpattern.net/wiki/index.php?title=Forms#Creating_a_New_Form. Go to Forms panel, located under "Presentation":http://textpattern.net/wiki/index.php?title=Presentation, and click the Create new form button at the top of the column on the right. This will open a new empty editor.
As with any form partial, you can type in any Textpattern markup you wish to the large code field. This field contains what your snippet will output when accessed using its URL. For now, type in the field this:
bc. ; Content-type: text/plain
<
You can then give the snippet a name by typing it in the Name field. This name will be also used for the snippet's URL. To register a form partial as a rah_external_output's snippet, the name should be prefixed with @raheo@. For now, give the form a name @rah_eo_hello_world@.
Last but not least is a Type. The most appropriate type for a snippet is a misc, but it can be anything if you so wish. Form types are for the most part visual, used for organizing things on the admin-side, from the Write panel's "Override Form":http://textpattern.net/wiki/index.php?title=Write field to the Tag Builder.
When you have done with the code, giving it a name and selecting a type, hit the Save button. The snippet is now ready for being accessed. After you have saved the editor, you will notice that there is a View link next to the Name field. By clicking the link you will be taken to the snippet's generated page.
That page is the snippets publicly accessible URL, which you can freely use as a page, to serve content to applications and use in client-side scripts. For the snippet @rah_eo_hello_world@ you just created, this URL would be:
bc. http://example.com/?rah_external_output=hello_world
Where @example.com@ is your site's URL and @hello_world@ the name of the snippet. When accessing the snippet, you should see the following output:
bc.
Where @MySiteName@ is the name of the site. As you may notice, the page is served as a plain text opposed to HTML. This is due to a HTTP header line the snippet's code included:
bc. ; Content-type: text/plain
All rah_external_output's snippets support few unique features including custom HTTP header lines and file extensions.
h2. Custom HTTP headers
In addition to a form partial's normal features, rah_external_output's special forms, snippets, support sending custom HTTP headers, including a content-type header.
All lines at the beginning of the form starting with a semicolon (@;@) are sent as HTTP headers. These lines should be placed at the very beginning of a form, starting from the first line. HTTP header lines can not be preceded by any white-space or empty lines.
HTTP header lines follow the normal syntax you would expect from a HTTP header field definitions. A line consist of a header property, also commonly referred as a field, followed by a colon (@:@) and a value.
bc. ; Property: Value
A form supports unlimited number of header lines. Each subsequent line starting with a semicolon is sent as a HTTP header.
bc. ; Content-type: text/javascript ; Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0 ; Expires: Sat, 24 Jul 2003 05:00:00 GMT ; Last-Modified: Wed, 1 Jan 2025 05:00:00 GMT ; Pragma: no-cache
Using these HTTP header lines visitor can be redirected, or document's content-type, encoding, caching or timestamp attributes changed. A form that starts with the following header line would be sent as a plain-text:
bc.. ; Content-type: text/plain
