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


Classes:
Services_Yahoo_JP_Auction
Services_Yahoo_JP_Auction_AbstractAuction
Services_Yahoo_JP_Auction_Category
Services_Yahoo_JP_Auction_Exhibit
Services_Yahoo_JP_Auction_Goods
Services_Yahoo_JP_Auction_Response
Services_Yahoo_JP_MA
Services_Yahoo_JP_MA_AbstractMA
Services_Yahoo_JP_MA_Parse
Services_Yahoo_JP_MA_Response
Services_Yahoo_JP_News
Services_Yahoo_JP_News_AbstractNews
Services_Yahoo_JP_News_Response
Services_Yahoo_JP_News_Topics
Services_Yahoo_JP_Search
Services_Yahoo_JP_Search_Image
Services_Yahoo_JP_Search_Video
Services_Yahoo_JP_Search_Web
Files:
AbstractAuction.php
AbstractMA.php
AbstractNews.php
Auction.php
category.php
exhibit.php
goods.php
image.php
MA.php
News.php
parse.php
Response.php
Response.php
Response.php
Search.php
Services_Yahoo_JP_Examples_01.php
topics.php
video.php
web.php

Class: Services_Yahoo_JP_Auction_AbstractAuction

Source Location: /Services_Yahoo_JP-0.1.1/Yahoo/JP/Auction/AbstractAuction.php

Class Overview




Abstract Auction class




Author(s):






        
          
              

Version:


    
  
  • Release: 0.0.1
    • 




Copyright:


    
  
  • 2008 Tetsuya Nakase
    • 







Variables






Methods















Child classes:






Services_Yahoo_JP_Auction_Goods

	
Services_Yahoo_JP_Auction_goods






Services_Yahoo_JP_Auction_Category

	
Services_Yahoo_JP_Auction_category






Services_Yahoo_JP_Auction_Exhibit

	
Services_Yahoo_JP_Auction_exhibit









Inherited Variables





Inherited Methods














Class Details



[line 41]

Abstract Auction class
This abstract class serves as the base class for all different  types of categories 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 295]

	

    

    

		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 ]

  

  
  
	
	
setAttn   [line 235]

	

    

    

		void setAttn(
[string
$attn = 1])
    

    


	
		Set the attn to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $attn  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setBuynow   [line 211]

	

    

    

		void setBuynow(
)
    

    


	
		Set the buynow to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setCategory   [line 117]

	

    

    

		void setCategory(
string
$id)
    

    


	
		Set the id to category for


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $id  
        — 
        to category for
      

        

    


        
[ Top ]

  

  
  
	
	
setEasypayment   [line 161]

	

    

    

		void setEasypayment(
)
    

    


	
		Set the easypayment to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setEscrow   [line 151]

	

    

    

		void setEscrow(
)
    

    


	
		Set the escrow to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setFreeshipping   [line 191]

	

    

    

		void setFreeshipping(
)
    

    


	
		Set the freeshipping to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setGiftIcon   [line 247]

	

    

    

		void setGiftIcon(
string
$gift_icon)
    

    


	
		Set the gift_icon to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $gift_icon  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setLargeimg   [line 181]

	

    

    

		void setLargeimg(
)
    

    


	
		Set the largeimg to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setNew   [line 171]

	

    

    

		void setNew(
)
    

    


	
		Set the new to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setOrder   [line 271]

	

    

    

		void setOrder(
string
$order)
    

    


	
		Set the order to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $order  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setPage   [line 129]

	

    

    

		void setPage(
string
$page)
    

    


	
		Set the page to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $page  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setSellerID   [line 283]

	

    

    

		void setSellerID(
string
$seller)
    

    


	
		Set the sellerID to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $seller  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setSort   [line 259]

	

    

    

		void setSort(
string
$sort)
    

    


	
		Set the sort to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $sort  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setStore   [line 141]

	

    

    

		void setStore(
string
$store)
    

    


	
		Set the store to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $store  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setThumbnail   [line 223]

	

    

    

		void setThumbnail(
[string
$thumbnail = 1])
    

    


	
		Set the thumbnail to auction


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $thumbnail  
        — 
        to auction
      

        

    


        
[ Top ]

  

  
  
	
	
setWrappingicon   [line 201]

	

    

    

		void setWrappingicon(
)
    

    


	
		Set the wrappingicon to auction


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
submit   [line 61]

	

    

    

		object Services_Yahoo_Response submit(
)
    

    


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


    

  • Return: Auction Tree result
    • 

  • Throws: Services_Yahoo_Exception
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Services_Yahoo_JP_Auction_Goods::submit()

		
submit  This is override function in Services_Yahoo_JP_Auction_AbstractAuction.

	

		

	
Services_Yahoo_JP_Auction_Category::submit()

		
submit  This is override function in Services_Yahoo_JP_Auction_AbstractAuction.

	

		

	
Services_Yahoo_JP_Auction_Exhibit::submit()

		
submit  This is override function in Services_Yahoo_JP_Auction_AbstractAuction.

	

	


        
[ Top ]

  

  
  
	
	
withAppID   [line 105]

	

    

    

		void withAppID(
string
$id)
    

    


	
		Set Application ID for the Auction
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
      

        

    


        
[ Top ]

  

  
  



        

		    

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