| Property | Type | Description | |
|---|---|---|---|
| $author | Use first matching element as author (0 or more xpath expressions) | ||
| $autodetect_on_failure | bool or null if undeclared | ||
| $body | Use first matching element as body (0 or more xpath expressions) | ||
| $cache_key | the options below cannot be set in the config files which this class represents | ||
| $date | Use first matching element as date (0 or more xpath expressions) | ||
| $find_string | Strings to search for in HTML before processing begins (used with $replace_string) | ||
| $http_header | Additional HTTP headers to send | ||
| $login_extra_fields | Extra fields to POST to the site's login form. | ||
| $login_password_field | string | Name of the site's login form password field. Example: password. | |
| $login_uri | string | Site's login form URI, if applicable. | |
| $login_username_field | string | Name of the site's login form username field. Example: username. | |
| $next_page_link | |||
| $not_logged_in_xpath | string | XPath query to detect if login is requested in a page from the site. | |
| $parser | string or null if undeclared | ||
| $prune | bool or null if undeclared | ||
| $replace_string | Strings to replace those found in $find_string before HTML processing begins | ||
| $requires_login | boolean | If fetching the site's content requires to authentify. | |
| $single_page_link | we will retrieve that page and the rest of the options in this config will be applied to the new page. | ||
| $strip | Strip elements matching these xpath expressions (0 or more) | ||
| $strip_id_or_class | Strip elements which contain these strings (0 or more) in the id or class attribute | ||
| $strip_image_src | Strip images which contain these strings (0 or more) in the src attribute | ||
| $test_url | Test URL - if present, can be used to test the config above | ||
| $tidy | Process HTML with tidy before creating DOM (bool or null if undeclared) | ||
| $title | Use first matching element as title (0 or more xpath expressions) |
| Property | Type | Description | |
|---|---|---|---|
| $default_autodetect_on_failure | |||
| $default_parser | |||
| $default_prune | |||
| $default_tidy |
| Method | Description | |
|---|---|---|
| autodetect_on_failure ( boolean $use_default = true ) : boolean | null | Autodetect title/body if xpath expressions fail to produce results. | |
| parser ( boolean $use_default = true ) : string | null | Which parser to use for turning raw HTML into a DOMDocument (either 'libxml' or 'html5lib'). | |
| prune ( boolean $use_default = true ) : boolean | null | Clean up content block - attempt to remove elements that appear to be superfluous. | |
| tidy ( boolean $use_default = true ) : boolean | null | Process HTML with tidy before creating DOM (bool or null if undeclared). |
| public $author |
| public $body |
| public $cache_key |
| public $date |
| public $find_string |
| public $login_extra_fields |
| public string $login_password_field | ||
| return | string | |
| public string $login_uri | ||
| return | string | |
| public string $login_username_field | ||
| return | string | |
| public string $not_logged_in_xpath | ||
| return | string | |
| public $replace_string |
| public bool $requires_login | ||
| return | boolean | |
| public $single_page_link |
| public $strip_id_or_class |
| public $strip_image_src |
| public $test_url |
| public $tidy |
