c_ws_plugin__s2member_readmes
public class c_ws_plugin__s2member_readmes
3.5
( 3 Methods ) Method Summary | |
|---|---|
| public static str | _parse_readme_specs(str $str) Callback parses specs in a readme file. |
| public static str | parse_readme(str $specific_path, str $specific_section, bool $_blank_targets, bool $process_wp_syntax) Handles readme parsing. |
| public static str|bool | parse_readme_value(str $key, str $specific_path) Parses readme specification keys. |
public static str _parse_readme_specs(str $str)
Callback parses specs in a readme file.
3.5
str $str - A string (i.e. the specs section).
str - Parsed specs. With HTML markup for list item display.
public static str parse_readme(str $specific_path, str $specific_section, bool $_blank_targets, bool $process_wp_syntax)
Handles readme parsing.
3.5
str $specific_path - Optional. Path to a specific readme file to parse. Defaults to that of the software itself. When/if a readme-dev.txt file is available, that will be used instead of the default readme.txt.
str $specific_section - Optional. The title of a specific section to parse, instead of the entire file.
bool $_blank_targets - Optional. Defaults to true. If false, no target attribute is used.
bool $process_wp_syntax - Optional. Defaults to false. If true, and WP Syntax is installed; it will be used to parse code samples.
str - Parsed readme file, or a parsed readme file section; based on parameter configuration.
public static str|bool parse_readme_value(str $key, str $specific_path)
Parses readme specification keys.
3.5
str $key - A key (within the specs section).
str $specific_path - Optional. Path to a specific readme file to parse. Defaults to that of the software itself. When/if a readme-dev.txt file is available, that will be used instead of the default readme.txt.
str|bool - The value of the key, else false if not found.
Readme file parsing.