Services_Yahoo_JP
[ class tree: Services_Yahoo_JP ] [ index: Services_Yahoo_JP ] [ all elements ]

Class: Services_Yahoo_JP_News_AbstractNews

Source Location: /Services_Yahoo_JP-0.1.1/Yahoo/JP/News/AbstractNews.php

Class Overview


Abstract News class


Author(s):

Version:

  • Release: 0.0.1

Copyright:

  • 2008 Tetsuya Nakase

Variables

Methods


Child classes:

Services_Yahoo_JP_News_Topics
Services_Yahoo_JP_News_topics

Inherited Variables

Inherited Methods


Class Details

[line 41]
Abstract News class

This abstract class serves as the base class for all different types of news that available through Services_Yahoo.



[ Top ]


Class Variables

$parameters = array('appid' => 'PEAR_Services_Y_JP')

[line 49]

parameter
  • Access: protected

Type:   array


[ Top ]



Method Detail

getParameter   [line 117]

string getParameter( string $name)

Returns an element from the parameters
  • Return: Value of the parameter idenfied by $name
  • Access: protected

Parameters:

string   $name   —  Name of the element

[ Top ]

setCategory   [line 157]

void setCategory( string $category)

Set the category
  • Access: public

Parameters:

string   $category   —  Search category

[ Top ]

setMidashiflg   [line 177]

void setMidashiflg( )

Set the midashiflg. It has a midashi.
  • Access: public

[ Top ]

setNum   [line 225]

void setNum( int $num)

Set the num
  • Access: public

Parameters:

int   $num   —  Appoint the indication number.

[ Top ]

setOrder   [line 201]

void setOrder( string $order)

Set the sorder
  • Access: public

Parameters:

string   $order   —  An order to sort.

[ Top ]

setRelatedsite   [line 189]

void setRelatedsite( [int $relatedsite = 1])

Set the relatedsite
  • Access: public

Parameters:

int   $relatedsite   —  It's a flag for showing related site

[ Top ]

setSort   [line 213]

void setSort( string $sort)

Set the sort
  • Access: public

Parameters:

string   $sort   —  An item to sort.

[ Top ]

setTopflg   [line 167]

void setTopflg( )

Set the topflg. It's only on the Yahoo!JAPAN's Top Page
  • Access: public

[ Top ]

setTopicname   [line 145]

void setTopicname( string $topicname)

Set the topicname
  • Access: public

Parameters:

string   $topicname   —  Search topics name

[ Top ]

setWord   [line 133]

void setWord( string $word)

Set the word
  • Access: public

Parameters:

string   $word   —  Search word in Topics

[ Top ]

submit   [line 61]

object Services_Yahoo_Response submit( )

Submits the News

This method submits the News and handles the response. It returns an instance of Services_Yahoo_Result which may be used to further make use of the result.

  • Return: News result
  • Throws: Services_Yahoo_Exception
  • Access: public

[ Top ]

withAppID   [line 105]

void withAppID( string $id)

Set Application ID

An Application ID is a string that uniquely identifies your application. Think of it as like a User-Agent string. If you have multiple applications, you should use a different ID for each one. You can register your ID and make sure nobody is already using your ID on Yahoo's Application ID registration page.

The ID defaults to "PEAR_Services_Y_JP", but you are free to change it to whatever you want. Please note that the access to the Yahoo API is not limited via the Application ID but via the IP address of the host where the package is used.

  • Access: public

Parameters:

string   $id   —  Application ID

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:25:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.